| 1 |
|
| 2 | [](https://travis-ci.org/esdoc/esdoc)
|
| 3 | [](https://codecov.io/gh/esdoc/esdoc)
|
| 4 | [](https://doc.esdoc.org/github.com/esdoc/esdoc)
|
| 5 |
|
| 6 | # ESDoc
|
| 7 |
|
| 8 | ESDoc is a documentation generator for JavaScript.<br/>
|
| 9 | Please <a href="https://try.esdoc.org">try it out</a>!
|
| 10 |
|
| 11 | <img class="screen-shot" src="https://raw.githubusercontent.com/esdoc/esdoc/master/manual/asset/image/top.png" width="500px" style="max-width: 500px; border: 1px solid rgba(0,0,0,0.1); box-shadow: 1px 1px 1px rgba(0,0,0,0.5);">
|
| 12 |
|
| 13 | # Features
|
| 14 | - Generates good documentation.
|
| 15 | - Measures documentation coverage.
|
| 16 | - Integrate test codes into documentation.
|
| 17 | - Integrate manual into documentation.
|
| 18 | - Parse ECMAScript proposals.
|
| 19 | - [ESDoc Hosting Service](https://doc.esdoc.org)
|
| 20 |
|
| 21 | # Users
|
| 22 | - [ESDoc](https://doc.esdoc.org/github.com/esdoc/esdoc/) (self-hosting 😄)
|
| 23 | - [RxJS](http://reactivex.io/rxjs/)
|
| 24 | - [Sketch API](http://developer.sketchapp.com/reference/api/)
|
| 25 |
|
| 26 | 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).
|
| 27 |
|
| 28 | # Quick Start
|
| 29 | ```sh
|
| 30 | # Move to a your project directory.
|
| 31 | cd your-project/
|
| 32 |
|
| 33 | # Install ESDoc and standard plugin.
|
| 34 | npm install --save-dev esdoc esdoc-standard-plugin
|
| 35 |
|
| 36 | # Create a configuration file.
|
| 37 | echo '{
|
| 38 | "source": "./src",
|
| 39 | "destination": "./docs",
|
| 40 | "plugins": [{"name": "esdoc-standard-plugin"}]
|
| 41 | }' > .esdoc.json
|
| 42 |
|
| 43 | # Run ESDoc.
|
| 44 | ./node_modules/.bin/esdoc
|
| 45 |
|
| 46 | # View a documentation
|
| 47 | open ./docs/index.html
|
| 48 | ```
|
| 49 |
|
| 50 | # Document
|
| 51 | please visit [esdoc.org](https://esdoc.org) to see more documentation.
|
| 52 |
|
| 53 | # License
|
| 54 | MIT
|
| 55 |
|
| 56 | # Author
|
| 57 | [Ryo Maruyama@h13i32maru](https://twitter.com/h13i32maru)
|