README.md

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

for v0.5.x

# move to a your project directory
cd your-project/

# install ESDoc from npm
npm install --save-dev esdoc

# write a configuration file.
echo '{"source": "./src", "destination": "./doc"}' > .esdoc.json

# run ESDoc
./node_modules/.bin/esdoc

# see a documentation
open ./doc/index.html

for v1.0.0-alpha.x

# move to a your project directory
cd your-project/

# install ESDoc from npm
npm install --save-dev esdoc esdoc-standard-plugin

# write a configuration file.
echo '{"source": "./src", "destination": "./doc", "plugins": [{"name": "esdoc-standard-plugin"}]}' > .esdoc.json

# run ESDoc
./node_modules/.bin/esdoc

# see a documentation
open ./doc/index.html

Document

please visit esdoc.org to see more documentation.

License

MIT

Author

Ryo Maruyama@h13i32maru