Skip to content
/ docma Public

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

License

Notifications You must be signed in to change notification settings

onury/docma

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Nov 22, 2016
90cb218 · Nov 22, 2016
Nov 20, 2016
Nov 22, 2016
Nov 22, 2016
Oct 31, 2016
Jun 10, 2016
May 19, 2016
Nov 20, 2016
Oct 31, 2016
Nov 22, 2016
Oct 31, 2016
May 19, 2016
Nov 22, 2016
Jun 10, 2016
Jun 13, 2016
Oct 31, 2016
May 19, 2016
Nov 22, 2016

Repository files navigation

Docma

npm release dependencies license maintained

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

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

Features

  • Parse JSDoc documentation, Markdown and HTML 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.
  • Build via API or CLI.
  • Extremely configurable and debuggable.
  • Well documented. ☝️

...like this:

Docma Screenshot

Installation

npm i docma -g

Documentation

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

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.