@emdaer/plugin-shields

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

latest

Source

npm

Version: 3.2.31

Version published: 6 years ago

Weekly downloads: 460

Maintainers: 4

Weekly downloads

Created: 5 years ago

Source

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

Keywords

emdaer-plugin

FAQs

What is @emdaer/plugin-shields?

Is @emdaer/plugin-shields popular?

Is @emdaer/plugin-shields well maintained?

Package last updated on 09 Apr 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install