ESDoc is a documentation generator for JavaScript.
Pleasetry it out!
- Generates good documentation.
- Measures documentation coverage.
- Integrate test codes into documentation.
- Integrate manual into documentation.
- Parse ECMAScript proposals.
- ESDoc Hosting Service
- ESDoc(self-hosting 😄)
- RxJS
- Sketch API
Andmore.
#Move to a your project directory.
cdyour-project/
#Install ESDoc and standard plugin.
npm install --save-dev esdoc esdoc-standard-plugin
#Create a configuration file.
echo'{
"source": "./src",
"destination": "./docs",
"plugins": [{ "name": "esdoc-standard-plugin" }]
}'>.esdoc.json
#Run ESDoc.
./node_modules/.bin/esdoc
#View a documentation
open./docs/index.htmlplease visitesdoc.orgto see more documentation.
MIT