Home Manual Reference Source Test Repository

Build Status Coverage Status Document Manual

ESDoc

ESDoc is a documentation generator for JavaScript.
Please try it out!

Features

Users

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.

License

MIT

Author

Ryo [email protected]