docma

Docma

© 2017, 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

Programmatic Usage

    var Docma = require('docma');
    Docma.create()
        .build(config)
        .then(function (success) {
            console.log('Documentation is built successfully.');
        })
        .catch(function (error) {
            console.log(error);
        });

See Build configuration.

Command-Line Usage

    docma -c path/to/docma.config.json -d path/to/destination

See Docma CLI reference.

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.5.0 (2017-03-10)

Docma (Builder)

Added

• config.jsdoc.ignored:Boolean option which specifies whether to include documentation symbols marked with @ignore tag.

Docma Web Core

Fixed

• An issue where empty lines would be stripped out from @example content.

Changed

• Improved auto-indention for code in comments.
• Improved $val filter.

Default Template

Added

• Template option outline, which determines the outline style of the sidebar symbols list. ("flat" or "tree"). See documentation and this example for outline set to "tree".
• Template option symbolMeta which specifies whether to add meta information at the end of each symbol documentation such as code file name and line number. Default is false.
• static badge for static members, deprecated badge for deprecated symbols.

Changed

• Improved sidebar design.
• Type.<T> is now represented as Type<T>.
• Default string values are now represented in quotes.

<br />