JSPM

esdoc-flow-plugin

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 10
  • Score
    100M100P100Q43500F
  • License MIT

A Flow plugin for ESDoc.

Package Exports

  • esdoc-flow-plugin

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (esdoc-flow-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

esdoc-flow-plugin

This plugin will remove all Flow annotations and types to produce the documentation.

Install and usage

npm install esdoc-flow-plugin

Setup plugin property in esdoc.json

{
  "source": "./src",
  "destination": "./doc",
  "plugins": [{
    "name": "esdoc-flow-plugin"
  }]
}

Execute ESDoc

esdoc -c esdoc.json

License

MIT

Author

Edgardo Avilés @eaviles