README.md

JSD to MD

Made for profit opinionated JSDoc to Markdown converter.

Usage

var bemjsd = require('bem-jsd'),
  jsdtmd = require('jsdtmd');

jsdtmd(bemjsd(code));

API

jsdtmd Module

function ( jsdocTree ) → {String}

Converts JSDoc JSON received from bem-jsd to Markdown string.

Parameters:

• jsdocTree {Object}
  Parsed JSDoc

Returns:

{String}

Related projects

• bem-jsd — wrapper for yet another JSDoc parser
• bem-xjst — XJST-based compiler

License

WTFPL