npm install inkdoc
|11||downloads in the last week|
|40||downloads in the last month|
|Version||0.3.0 last updated a month ago|
|Dependencies||esprima, fs-extra, handlebars, marked, simple-glob|
It shouldn't be THAT difficult to tame a documentation generation engine.
The rationale here is to have a generic-enough solution.
One can edit and extend its logic (kinda hard) and templates (easy as pie - it uses Handlebars!).
npm install -g inkdoc
(sudo may be required depending on your system configuration)
- inkdoc API (generated from the files in lib folder)
- your page can be here!
The engine is split into the following parts:
- comments parsing into JSON metadata
- additional massaging of the extracted data is done in
- markup generation from JSON metadata
It uses handlebars templates for generating the final markup.
It uses marked to convert markdown syntax to HTML.
It groups information in a hierarchy of modules, classes and functions/attributes.
You can find a human-readable log of inkdoc versions and their changes here