node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org »

docma

Docma

npm release dependencies license maintained

© 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. 😎
  • 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

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.