开发者社区> 镜像站> NPM> gendo
gendo
Generates docs via documentationjs, updates README checks that in and then generates github pages with nicely rendered docs.
Last updated 2 years ago by thlorenz .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install gendo 
SYNC missed versions from official npm registry.

gendo

Generates docs via documentationjs, updates README checks that in and then generates github pages with nicely rendered docs.

assets/gendo.gif

# 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

Current Tags

  • 2.0.0                                ...           latest (2 years ago)

2 Versions

  • 2.0.0                                ...           2 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 0
Dependencies (1)
Dev Dependencies (0)
None
Dependents (0)
None