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

Document

please visit esdoc.org to see more documentation.

License

MIT

Author

Ryo Maruyama@h13i32maru