© 2019, Onur Yıldırım (@onury).
- 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. ☝️
This is generated with the built-in template, Zebra.
click to view live
npm i docma -D
Building Documentation with CLI
You can use Docma CLI to build documentations directly from your console.
Once you create the configuration file
docma.json in your project root, it's quite simple.
You can even serve the docs locally and test.
Building Documentation Programmatically
If you need to build documentation from within your code, use the API.
const Docma = ;
Either by passing a configuration object.
const config =src:'./code/**/*.js''./README.md'dest: './output/doc';Docma;
Or by reading configuration from a JSON file.
See Docma API Reference.
Sometimes, the issue is with invalid JSDoc comments. See this for linting/validating your JSDoc while you type and within a build process.
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.
|Docma version||Node version|
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.