<!--
  This file was generated by emdaer

  Its template can be found at .emdaer/README.emdaer.md
-->

<!--
  emdaerHash:45f242b91484b15e0a4243e5dfdaadcd
-->

<h1 id="-emdaer-plugin-shields-travis-documented-with-emdaer-maintained-with-lerna">@emdaer/plugin-shields · <a href="https://travis-ci.org/emdaer/emdaer/"><img src="https://img.shields.io/travis/emdaer/emdaer.svg?style=flat-square" alt="Travis"></a> <a href="https://github.com/emdaer/emdaer"><img src="https://img.shields.io/badge/📓-documented%20with%20emdaer-F06632.svg?style=flat-square" alt="Documented with emdaer"></a> <a href="https://lernajs.io/"><img src="https://img.shields.io/badge/🐉-maintained%20with%20lerna-cc00ff.svg?style=flat-square" alt="Maintained with lerna"></a></h1>
<p>An emdaer plugin that renders metadata badges for open source projects from shields.io</p>
<h2 id="usage">Usage</h2>
<p>@emdaer/plugin-shields is an <a href="https://github.com/emdaer/emdaer/">emdaer</a> plugin – see the <a href="https://github.com/emdaer/emdaer/">emdaer monorepo</a> for more information</p>
<h2 id="documentation">Documentation</h2>
<h3 id="example">Example</h3>
<p><a href="https://github.com/emdaer/emdaer"><img src="https://img.shields.io/badge/📓-documented%20with%20emdaer-F06632.svg?style=flat-square" alt="Documented with emdaer"></a></p>
<h3 id="usage-in-readme">Usage in README</h3>

```md
<!--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'
-->
```
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
<h2 id="shieldsplugin">shieldsPlugin</h2>
<p>Render metadata badges for open source projects from shields.io.</p>
<p><strong>Parameters</strong></p>
<ul>
<li><code>options</code> <strong>any</strong> <ul>
<li><code>options.shields</code> <strong><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;Shield&gt;?</strong> The shields.</li>
</ul>
</li>
</ul>
<p><strong>Examples</strong></p>

```javascript
<!--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'
-->
```
<p>Returns <strong><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</strong> Markdown images, one per shield, all on one line.</p>
