@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

• See: http://documentation.js.org/

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

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.2.31 (2020-04-09)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.30 (2020-04-09)

Bug Fixes

• butter sock (933a599)

3.2.29 (2020-04-09)

Features

• todo (27e245c)

3.2.28 (2020-04-09)

Reverts

• Revert "chore: publish v3.2.27 [ci skip]" (79e2f9d)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.26 (2019-07-09)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.25 (2019-07-09)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.24 (2019-07-08)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.23 (2019-07-08)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.22 (2019-07-08)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.21 (2019-07-08)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.20 (2019-07-08)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.19 (2019-07-08)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.18 (2019-07-06)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.17 (2019-07-06)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.16 (2019-07-05)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.15 (2019-07-05)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.14 (2019-07-04)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.13 (2019-07-04)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.12 (2019-07-03)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.11 (2019-07-03)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.10 (2019-07-03)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.9 (2019-07-03)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.8 (2019-07-03)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.7 (2019-07-03)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.6 (2019-06-19)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.5 (2019-06-18)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.4 (2019-01-16)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.3 (2018-05-25)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.2 (2018-05-25)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.1 (2018-05-23)

Note: Version bump only for package @emdaer/plugin-documentation

3.2.0 (2018-05-18)

Features

• simplify cli (1ff54b9), closes #89 #96

BREAKING CHANGES

• @emdaer/cli now prompts the user if a manual change to the compiled README is detected. Use --yes to skip the prompt and automatically overwrite the README

3.0.0 (2018-05-11)

Features

• simplify cli (1ff54b9), closes #89 #96

BREAKING CHANGES

• @emdaer/cli now prompts the user if a manual change to the compiled README is detected. Use --yes to skip the prompt and automatically overwrite the README

2.4.0 (2018-04-29)

Features

• plugin-jsdoc-tag-value: add plugin and self document (13130cd)

2.1.1 (2018-04-29)

Note: Version bump only for package @emdaer/plugin-documentation

2.1.0 (2018-04-29)

Note: Version bump only for package @emdaer/plugin-documentation

2.0.3 (2018-04-21)

Note: Version bump only for package @emdaer/plugin-documentation

2.0.2 (2018-04-14)

Note: Version bump only for package @emdaer/plugin-documentation

2.0.1 (2018-04-14)

Bug Fixes

• core: override marked to output md. remove minifier (9fb0c27)

2.0.0 (2018-02-21)

Features

• build: update some lerna things (19e88fd)

BREAKING CHANGES

• build: woo finally shipping v2!

1.8.15 (2018-02-21)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.14 (2018-02-21)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.13 (2018-02-21)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.12 (2018-02-20)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.11 (2018-02-19)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.10 (2018-02-19)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.9 (2018-02-19)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.8 (2018-02-02)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.7 (2018-01-15)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.6 (2018-01-15)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.5 (2018-01-15)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.4 (2018-01-01)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.3 (2018-01-01)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.2 (2017-12-25)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.1 (2017-12-10)

Note: Version bump only for package @emdaer/plugin-documentation

1.8.0 (2017-12-10)

Note: Version bump only for package @emdaer/plugin-documentation

1.7.0 (2017-12-09)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.20 (2017-12-09)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.19 (2017-11-27)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.18 (2017-11-27)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.17 (2017-11-27)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.16 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.15 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.14 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.13 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.12 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.11 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.10 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.9 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.8 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.7 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.6 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.5 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.4 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.3 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.2 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.1 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.6.0 (2017-11-17)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.50 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.49 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.48 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.47 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.46 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.45 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.44 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.43 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.42 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.41 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.40 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.39 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.38 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.37 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.36 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.35 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.34 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.33 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.32 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.31 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.30 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.29 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.28 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.27 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.26 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.25 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.24 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.23 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.22 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.21 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.20 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.19 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.18 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.17 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.16 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.15 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.14 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.13 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.12 (2017-11-12)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.11 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.10 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.9 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.8 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.7 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.6 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.5 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.4 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.3 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.5.2 (2017-11-11)

Note: Version bump only for package @emdaer/plugin-documentation

1.2.1 (2017-10-30)

Note: Version bump only for package @emdaer/plugin-documentation

1.0.0 (2017-10-29)

Note: Version bump only for package @emdaer/plugin-documentation