ESDoc - Good Documentation for JavaScript
Clone or download
Pull request Compare This branch is 54 commits behind esdoc:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
manual
script
src
test
.babelrc
.editorconfig
.esdoc.json
.eslintignore
.eslintrc.js
.gitignore
.nycrc
.travis.yml
CHANGELOG.md
LICENSE
README.md
package.json

README.md

Build Status Coverage Status Document

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

And more.

Quick Start

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

# install ESDoc and standard plugin
npm install esdoc esdoc-standard-plugin

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

# run ESDoc
./node_modules/.bin/esdoc

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

Document

please visit esdoc.org to see more documentation.

License

MIT

Author

Ryo Maruyama@h13i32maru