Nautical Pirate Moustache
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    docmapublic

    Docma

    npm release license downloads dependencies maintained documentation
    © 2018, Onur Yıldırım (@onury).

    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, comes with template authoring tools.
    • Works great with GitHub Pages, Amazon S3, Nginx, Apache, etc...
    • Build via API or CLI.
    • Extremely configurable and debuggable.
    • Well documented. ☝️

    ...like this:

    Docma screen

    This is generated with the built-in template, Zebra.
    click to view live

    Installation

    npm i docma -g

    Building Documentation with CLI

    You can use Docma CLI to build documentations directly from your console. Once you create the configuration (JSON) file, it's quite simple.

    docma -c path/to/docma.json

    You can even serve the docs locally and test.

    docma serve path/to/docs

    See

    Building Documentation Programmatically

    If you need to build documentation from within your code, use the API.

    const Docma = require('docma');

    Either by passing a configuration object.

    const config = {
        src: [
            './code/**/*.js',
            './README.md'
        ],
        dest: './output/doc'
    };
    Docma.create()
        .build(config)
        .then(success => console.log('Documentation is built successfully.'))
        .catch(error => console.log(error));

    Or by reading configuration from a JSON file.

    Docma.create()
        .build('./path/to/docma.json')
        .catch(error => console.log(error));

    See Docma API Reference.

    Parsed Output

    To investigate the parsed JSDoc output, enable the debug option that will create a JSON output(s) within the root of the destination directory. If you have a problem with the parsed documentation data, open an issue @ jsdoc-x. (I'm the author.)

    For markdown output issues (that are not related with style), you can open an issue @ marked.

    Change-log

    See CHANGELOG.
    Note: If you're upgrading from Docma v1.x to v2.x, there are some breaking changes.

    Documentation

    Read Docma documentation, built with Docma, for a Docma demo... 👀

    License

    MIT. You don't have to include any copyright notice in your documentation output or templates but I'd appreciate if you let people know about this tool so we can read better documentations.

    Emoji shortcuts used in source markdown files are parsed into twemoji. Graphics and icons licensed under CC-BY 4.0.

    Related Modules

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

    install

    npm i docma

    Downloadsweekly downloads

    128

    version

    2.0.0

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar