a KISS JavaScript documentation engine
JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
lib
templates
tests
.gitignore
.inkdocrc
.jshintrc
API.md
HOW_TO.md
LICENSE
LOG.md
README.md
package.json

README.md

inkdoc - a KISS JavaScript documentation engine

dependency status published version still maintained?

NPM NPM


motivation

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!).

install

npm install -g inkdoc

(sudo may be required depending on your system configuration)

how to

sample results

internals

The engine is split into the following parts:

  • comments parsing into JSON metadata parseComments
  • additional massaging of the extracted data is done in prepareStructure
  • markup generation from JSON metadata generateMarkup

It uses esprima to extract block comments from JavaScript source files.

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.

log

You can find a human-readable log of inkdoc versions and their changes here