Package Exports
- esdoc
- esdoc/out/src/Doc/AbstractDoc
- esdoc/out/src/Doc/FileDoc
- esdoc/out/src/ESDoc.js
- esdoc/out/src/ESDocCLI.js
- esdoc/out/src/Parser/CommentParser
- esdoc/out/src/Parser/ESParser
- esdoc/out/src/Parser/ParamParser
- esdoc/out/src/Util/ASTUtil
- esdoc/out/src/Util/InvalidCodeLogger
- esdoc/out/src/Util/PathResolver
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) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
ESDoc
ESDoc is a documentation generator for JavaScript.
Please try it out!
Features
- Generates good documentation.
- Measures documentation coverage.
- Integrate test codes into documentation.
- Integrate manual into documentation.
- Parse ECMAScript proposals.
- ESDoc Hosting Service
Users
- ESDoc (self-hosting 😄)
- RxJS
- Sketch API
And more.
Quick Start
# Move to a your project directory.
cd your-project/
# Install ESDoc and standard plugin.
npm install --save-dev esdoc esdoc-standard-plugin
# Create a configuration file.
echo '{
"source": "./src",
"destination": "./docs",
"plugins": [{"name": "esdoc-standard-plugin"}]
}' > .esdoc.json
# Run ESDoc.
./node_modules/.bin/esdoc
# View a documentation
open ./docs/index.htmlDocument
please visit esdoc.org to see more documentation.
License
MIT