Package Exports

docma

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docma) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Docma

npm release dependencies license

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

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

Features

Parse JSDoc documentation and Markdown 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.
Extremely configurable and debuggable.
Well documented. ☝️

...like this:

Installation

npm i docma

Documentation

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

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.

docma