esxdoc

This is a fork

I need a fix for #365 and there is a pending PR, so I release it for myself / others.

ESDoc

ESDoc is a documentation generator for JavaScript(ES2015 or later).

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

Document

please visit esdoc.org to see more documentation.

roadmap of v1.0.0

License

MIT