@zigen/esdoc
fork from https://github.com/esdoc/esdoc :Good Documentation Generator For JavaScript
Last updated 2 years ago by zigen .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @zigen/esdoc 
SYNC missed versions from official npm registry.

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

Current Tags

  • 1.0.1                                ...           latest (2 years ago)

1 Versions

  • 1.0.1                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 5
Dependencies (11)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |