@newyork.anthonyng/docco-lite
v0.2.1
Published
Literate-programming-style documentation generator
Downloads
4
Readme
Docco-lite
Made just for fun as part of my deliberate practice.
Reimplementation of docco
. docco
supports many more languages (and is probably less buggy). docco-lite
only supports JavaScript
.
Getting started
Install docco-lite
into your project:
npm install --save-dev @newyork.anthonyng/docco-lite
To use docco-lite
to create documentation for a file, app.js
, run:
./node_modules/.bin/docco-lite app.js
See here for an example of the documentation created by docco-lite
.
Contributing
This project uses commitizen
and nps
.
To commit, run:
npm start commit