/docma

A powerful tool to easily generate beautiful HTML documentation from Javascript (JSDoc) and Markdown files.

Primary LanguageJavaScriptOtherNOASSERTION

Docma

npm release dependencies license

© 2016, Onur Yıldırım (@onury). MIT License.

A powerful tool to easily generate beautiful HTML documentation from Javascript (JSDoc) and Markdown files.

Features

  • Parse JSDoc documentation and Markdown files.
  • Build a cool SPA (Single Page Application) from parsed files.
  • Generate multiple/separate API documentations by grouping JS files.
  • Path or Query-string based app routing.
  • Non-opinionated engine, built-in template with cool opinions. 😎
  • Supports custom templates.
  • Works great with GitHub Pages.
  • Extremely configurable and debuggable.
  • Well documented. ☝️

...like this:

Docma Screenshot

Installation

npm i docma

Documentation

Read Docma documentation, built with Docma, for a Docma demo... ;)

CLI

npm i -g docma
docma [input ...] -o [output] # input files and output directory
docma -f [config.json] # json config

Related Modules

  • grunt-docma — Grunt task for Docma.
  • jsdoc-x — Parser for outputting a Javascript object from documented code via JSDoc's explain (-X) command.
  • marked — A full-featured markdown parser and compiler, written in JavaScript. Built for speed.
  • dustjs — Asynchronous Javascript templating for the browser and server.