@emdaer/plugin-shields ·

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

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.