gendo
v2.0.0
Published
Generates docs via documentationjs, updates README checks that in and then generates github pages with nicely rendered docs.
Downloads
2
Readme
gendo
Generates docs via documentationjs, updates README checks that in and then generates github pages with nicely rendered docs.
# let documentationjs find the files to document
gendo
# specify the files to generate docs for
gendo file1.js lib/file2.js
Requirements
- a
README.md
with an API section, i.e.## API
- a
gh-pages
branch, if not found it is generated for you
Installation
npm install gendo
Docs generated with gendo
ah-collector
License
MIT