JSPM

work in progress, unstable, draft documentation

#jsdoc-to-markdown Documented source code in, markdown out.. In development, any feedback welcome.

##Install Ensure node.js is installed first. Linux/Mac users may need to run the following commands with sudo.

###Globally

$ npm install -g jsdoc-to-markdown

###Bundled with your project

$ npm install jsdoc-to-markdown --save-dev

Then add an docs build task to your package.json scripts, e.g.:

{
  "name": "my-web-app",
  "version": "1.0.0",
  "scripts": {
    "docs": "jsdoc2md --index lib/*.js"
  }
}

This approach abstracts implementation details away, saving collaborators the hassle of installing / learning jsdoc-to-markdown. Docs are generated like so:

$ npm run docs

###As a grunt plug-in See grunt-jsdoc-to-markdown.

##Usage Document your source code using correct jsdoc syntax, then run it through jsdoc2md.

$ jsdoc2md <options> <source_files>

-t, --template <string>  A custom handlebars template to insert the rendered documentation into,
                         overriding the default
-p, --preset <string>    Use a preset template ('default', 'global' or 'modules')
-j, --json               Output the template data only
-h, --help               Print usage information
--src <array>            The javascript source files. The default option.
--index                  Include an index for each module and class, linking to members
--skip-heading           Skip the module heading, useful if you already have the heading
                         elsewhere in your template.
--private                Include symbols marked @private in the output

##examples These projects have readme files rendered by jsdoc2md:

• https://github.com/75lb/handbrake-js
• https://github.com/75lb/array-tools
• https://github.com/75lb/file-set
• https://github.com/75lb/command-line-args

#API Reference

Example

var jsdoc2md = require("jsdoc-to-markdown");

###jsdoc2md.render(options) Params

• options object - The render options
  • [template] string - A handlebars template to insert your documentation into.
  • [preset] string - Choose from one of the built-in templates
  • [json] boolean - Return the JSON template data only
  • [src] Array.<string> - The javascript source files
  • [index] boolean - Include an index for each module and class, linking to members
  • [skip-heading] boolean - Skip the module heading, useful if you already have the heading elsewhere in your template.
  • [private] boolean - Include symbols marked @private in the output
• onRender - a callback invoked on completion

###callback: onRender Called by jsdoc2md.render() on completion.

Params

• err object - An error instance if applicable, else null
• result string - the rendered markdown

Scope: inner typedef of jsdoc-to-markdown
Type: function