Namedocco-husky DescriptionGenerated static project documentation primarily for node.js projects. A fork of Docco AuthorMike Brevoort <mike@brevoort.com> Version0.2.0 Dependencieslatest 0.1.2 0.17.0 Statshttp://cloc.sourceforge.net v 1.55 T=0.5 s (2.0 files/s, 680.0 lines/s) ------------------------------------------------------------------------------- Language files blank comment code ------------------------------------------------------------------------------- Javascript 1 0 2 338 ------------------------------------------------------------------------------- | OverviewA streamlined static site generator for project documentation based on Docco. "Husky" because it's bigger and more irregular than Docco, like Husky Jeans you would buy at Sears back in the day. A fork of Docco, intended to go beyond the appropriate scope of Docco itself. Forked because Docco itself is pretty simple and this is intended to diverge. The initial fork included merged pull requests from nevir and jswartwood for their work on supporting recursive directories and an improved "Jump To" menu. ExamplesCheck out the generated documentation for this project. Or these other samples InstallationPossible Gotchas
To install via npm into your project:
Install globally:
Or include as a dependency in your package.json Generating Documentationdocco-husky will generate docs in a ./docs directory. It accepts multiple files (including wildcards) and directories for it to recurse.
Examples
Outputdocco-husky will write generated files to ./docs . For all source files, the output will be like
A readme.html will be generate and will include a formatted version of a README.md if your project includes it, some details from the a package.json file, and project stats generated by cloc. |