docma

Docma

© 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. :sunglasses:
• Supports custom templates.
• Works great with GitHub Pages.
• Build via API or CLI.
• Extremely configurable and debuggable.
• Well documented. :point_up:

...like this:

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.

Changelog

1.3.0 (2016-11-23)

Docma (Builder)

Added

• Case-sensitive routing option. config.app.routing accepts either a String ("query" or "path" as before) or now, an Object. e.g. { type: "query", caseSensitive: true }. This also fixes issue #3.

Changed

• Updated dependencies to their latest versions.
• Minor code revisions.

Docma Web Core

Added

• Extended support for parsing back-ticks in documentation. Added triple back-tick support for multiline code blocks (<code>```</code>).

Changed

• Improved docma.utils.normalizeTabs() method. Deep indents in JSDoc comments/descriptions are also normalized.
• Improved support for <pre></pre> tags within JSDoc descriptions.

Default Template

Fixed

• An issue where symbols with return type parameters (such as Promise<Array>) would not be escaped and parsed properly. Fixes issue #4.
• An issue where boolean symbol parameters' default values would not be parsed properly. Fixes issue #5.

<br />