@emdaer/plugin-documentation

3.2.31 • Public • Published

@emdaer/plugin-documentation · Travis Documented with emdaer Maintained with lerna

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

Readme

Keywords

Package Sidebar

Install

npm i @emdaer/plugin-documentation

Weekly Downloads

166

Version

3.2.31

License

MIT

Unpacked Size

31.3 kB

Total Files

8

Last publish

Collaborators

  • beautyhammer
  • emdaerbot
  • flipactual
  • infiniteluke