@emdaer/plugin-documentation ·
An emdaer plugin to generate documentation from your code comments using documentationjs
Usage
@emdaer/plugin-documentation is an emdaer plugin – see the emdaer monorepo for more information
Documentation
Example
documentationPlugin
Render documentation from specified source code.
Parameters
-
options
any-
options.sources
array? Globs that specify the paths to the documentation sources.
-
Examples
<!--emdaer-p
- '@emdaer/plugin-documentation'
- sources:
- ./src/index.js
-->
Returns Promise<string> The rendered documentation
Usage in README
<!--emdaer-p
- '@emdaer/plugin-documentation'
- sources:
- ./src/index.js
-->