<!--
  This file was generated by emdaer

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

<!--
  emdaerHash:ca56f2b8336e37af36f25ab7418475df
-->

<h1 id="-emdaer-plugin-documentation-travis-documented-with-emdaer-maintained-with-lerna">@emdaer/plugin-documentation · <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 to generate documentation from your code comments using documentationjs</p>
<h2 id="usage">Usage</h2>
<p>@emdaer/plugin-documentation 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>
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
<h2 id="documentationplugin">documentationPlugin</h2>
<ul>
<li><strong>See: <a href="http://documentation.js.org/">http://documentation.js.org/</a></strong></li>
</ul>
<p>Render documentation from specified source code.</p>
<p><strong>Parameters</strong></p>
<ul>
<li><code>options</code> <strong>any</strong> <ul>
<li><code>options.sources</code> <strong><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">array</a>?</strong> Globs that specify the paths to the documentation sources.</li>
</ul>
</li>
</ul>
<p><strong>Examples</strong></p>

```javascript
<!--emdaer-p
  - '@emdaer/plugin-documentation'
  - sources:
    - ./src/index.js
-->
```
<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> The rendered documentation</p>
<h3 id="usage-in-readme">Usage in README</h3>

```md
<!--emdaer-p
  - '@emdaer/plugin-documentation'
  - sources:
    - ./src/index.js
-->
```
