[](https://travis-ci.org/esdoc/esdoc)
[](https://codecov.io/gh/esdoc/esdoc)
[](https://doc.esdoc.org/github.com/esdoc/esdoc)
# 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](https://doc.esdoc.org)
# Users
- [ESDoc](https://doc.esdoc.org/github.com/esdoc/esdoc/) (self-hosting)
- [RxJS](http://reactivex.io/rxjs/)
- [Sketch API](http://developer.sketchapp.com/reference/api/)
And [more](https://github.com/search?o=desc&q=esdoc+filename%3Apackage.json+-user%3Ah13i32maru+-user%3Aesdoc+-user%3Aes-doc&ref=searchresults&s=indexed&type=Code&utf8=%E2%9C%93).
# Quick Start
```sh
# Move to a your project directory.
cd your-project/
# Install ESDoc and standard plugin.
npm install --save-dev @longnc/themartec-esdoc @longnc/themartec-esdoc-standard-plugin
# Create a configuration file.
echo '{
"source": "./src",
"destination": "./docs",
"plugins": [{"name": "@longnc/themartec-esdoc-standard-plugin"}]
}' > .esdoc.json
# Run ESDoc.
./node_modules/.bin/esdoc
# View a documentation
open ./docs/index.html
```
# Document
please visit [esdoc.org](https://esdoc.org) to see more documentation.
# License
MIT
# Author
[Long Nguyen ](https://github.com/longthemartec)