@sebastianwessel/esdoc
v2.1.0
Published
Fork of ESDoc - A Good Documentation Generator For JavaScript
Downloads
242
Maintainers
Readme
ESDoc
Fork of ESDoc with up-to-date dependencies
Quick Start
# Move to a your project directory.
cd your-project/
# Install ESDoc and standard plugin.
npm install --save-dev @sebastianwessel/esdoc @sebastianwessel/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.html
Document
please visit esdoc.org to see more documentation.
License
MIT