@emdaer/plugin-shields

    3.2.31 • Public • Published

    @emdaer/plugin-shields · Travis Documented with emdaer Maintained with lerna

    An emdaer plugin that renders metadata badges for open source projects from shields.io

    Usage

    @emdaer/plugin-shields is an emdaer plugin – see the emdaer monorepo for more information

    Documentation

    Example

    Documented with emdaer

    Usage in README

    <!--emdaer-p
      - '@emdaer/plugin-shields'
      - shields:
          - alt: 'Documented with emdaer'
            image: 'badge/📓-documented%20with%20emdaer-F06632.svg'
            link: 'https://github.com/emdaer/emdaer'
            style: 'flat-square'
    -->

    shieldsPlugin

    Render metadata badges for open source projects from shields.io.

    Parameters

    • options any
      • options.shields Array<Shield>? The shields.

    Examples

    <!--emdaer-p
      - '@emdaer/plugin-shields'
      - shields:
          - alt: 'Documented with emdaer'
            image: 'badge/📓-documented%20with%20emdaer-F06632.svg'
            link: 'https://github.com/emdaer/emdaer'
            style: 'flat-square'
    -->

    Returns Promise<string> Markdown images, one per shield, all on one line.

    Install

    npm i @emdaer/plugin-shields

    DownloadsWeekly Downloads

    24,925

    Version

    3.2.31

    License

    MIT

    Unpacked Size

    32.1 kB

    Total Files

    8

    Last publish

    Collaborators

    • beautyhammer
    • emdaerbot
    • flipactual
    • infiniteluke