dmd

What is dmd?

The dmd (documentation markdown) npm package is a tool for generating markdown documentation from JSDoc comments in your JavaScript code. It allows you to create well-structured and readable documentation for your projects.

What are dmd's main functionalities?

Generate Markdown Documentation

This feature allows you to generate markdown documentation from JSDoc comments in your JavaScript files. The code sample demonstrates how to use dmd in conjunction with jsdoc-to-markdown to read JSDoc data from a file and convert it into markdown format.

const dmd = require('dmd');
const jsdoc2md = require('jsdoc-to-markdown');

const jsdocData = jsdoc2md.getTemplateDataSync({ files: 'your-file.js' });
const output = dmd(jsdocData);
console.log(output);

Custom Templates

This feature allows you to use custom templates to format the generated markdown documentation. The code sample shows how to define a custom template and use it with dmd to generate documentation.

const dmd = require('dmd');
const jsdoc2md = require('jsdoc-to-markdown');

const jsdocData = jsdoc2md.getTemplateDataSync({ files: 'your-file.js' });
const template = '{{#module}}{{name}}{{/module}}';
const output = dmd(jsdocData, { template: template });
console.log(output);

Helper Functions

This feature allows you to define and use custom helper functions in your templates. The code sample demonstrates how to create a helper function that converts text to uppercase and use it in the generated documentation.

const dmd = require('dmd');
const jsdoc2md = require('jsdoc-to-markdown');

const jsdocData = jsdoc2md.getTemplateDataSync({ files: 'your-file.js' });
const helpers = {
  uppercase: function (str) { return str.toUpperCase(); }
};
const output = dmd(jsdocData, { helper: helpers });
console.log(output);

Other packages similar to dmd

jsdoc-to-markdown

jsdoc-to-markdown is a tool that generates markdown documentation from JSDoc comments. It is often used in conjunction with dmd to provide the data that dmd formats into markdown. Unlike dmd, jsdoc-to-markdown focuses on extracting and converting JSDoc comments into a format that can be further processed.

documentation

documentation is a documentation generation tool that supports multiple output formats, including HTML and markdown. It provides a more comprehensive solution compared to dmd, with built-in support for various output formats and more advanced features like linting and validation of JSDoc comments.

docco

docco is a quick-and-dirty documentation generator that produces HTML documentation with source code and comments side-by-side. While it does not generate markdown like dmd, it is useful for creating readable documentation that closely follows the source code.

README

preview release, not much documentation.. new version and docs coming soon

#dmd A transform stream transforming doclet json input in (produced by jsdoc-parse or any source) into markdown documentation. The default template is inspired by the node documentation. See here for an example. Essentially, the library is collection of Handlebars templates and helpers, any of which can be overridden to taste. The main template is rendered using the data received at stdin.

##Customise No doubt there is something about the default template you don't like, there normally is. Use these block helpers to do it yourself.

Helper name	Description

##Default Template

###Partials

Partial name	Description
main.hbs	The template that is rendered, taking the doclet json as input. The jsdoc2md --json option will display that data.
main-index.hbs	The main index. Will only be display if at least 2 "parent" identifiers are documented.

##Synopsis examples/input/doclet.json:

[
    {
        "name": "fatUse",
        "kind": "member",
        "description": "I am a global variable",
        "scope": "global"
    }
]

$ cat examples/input/doclet.json | dmd
#Global

##fatUse
I am a global variable

##Usage ###As a library Install:

$ npm install dmd --save

Example:

var dmd = require("dmd");

process.stdin.pipe(dmd()).pipe(process.stdout);

###At the command line Install the dmd tool globally:

$ npm install -g dmd

Example:

$ cat examples/doclet.json | dmd

##Plugins

• dmd-examples-highlight

#API Reference ##dmd(options) ⏏ Transforms doclet data into markdown documentation

Params

• options object - The render options
  • [template] string - A handlebars template to insert your documentation into.
  • [partial] string | Array.<string> - overrides
  • [helper] string | Array.<string> - overrides
  • [plugin] string | Array.<string> - packages containing overrides
  • [heading-depth] number - Root heading depth, defaults to 2.

Returns: stream - A transform stream - pipe doclet data in to receive rendered markdown.

documented by jsdoc-to-markdown