@emdaer/plugin-shields

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

Stats

StarsIssuesVersionUpdatedCreatedSize
@emdaer/plugin-shields
14293.2.31a year ago4 years agoMinified + gzip package size for @emdaer/plugin-shields in KB

Readme

@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.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.