Package Exports
- @flux159/esdoc
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 (@flux159/esdoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
A fork of ESDoc that uses Less for some styling fixes and also enables manual searching.
Published via npm as @flux159/esdoc:
npm install @flux159/esdocESDoc
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
# install ESDoc from npm
npm install -g esdoc
# move to a your project directory
cd your-project/
# write a configuration file.
echo '{"source": "./src", "destination": "./doc"}' > .esdoc.json
# run ESDoc
esdoc
# see a documentation
open ./doc/index.htmlDocument
please visit esdoc.org to see more documentation.
License
MIT