Name: docma
Owner: GeoSolutions
Description: A powerful tool to easily generate beautiful HTML documentation from Javascript (JSDoc) and Markdown files.
Forked from: onury/docma
Created: 2017-03-09 18:02:56.0
Updated: 2017-03-09 18:02:57.0
Pushed: 2017-03-10 08:49:02.0
Homepage:
https://onury.github.io/docma
Size: 893
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Email | Most Recent Commit | # Commits |
|---|
README
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
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.
