esxdoc
Good Documentation Generator For JavaScript
Last updated 3 years ago by ratson .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install esxdoc 
SYNC missed versions from official npm registry.

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

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

Current Tags

  • 0.0.1                                ...           latest (3 years ago)

1 Versions

  • 0.0.1                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 4
Dependencies (11)
Dev Dependencies (10)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |