grunt-typedoc2md

convert typedoc to markdown.

content

• Usage (see further down this page)

  • Prerequisites
  • Getting started guide
  • Usage and examples

• Developers

  • Testing grunt-typedoc2md
  • Code coverage of tests for grunt-typedoc2md
  • Build grunt-typedoc2md from scratch
  • NPM integration of grunt-typedoc2md
  • Frameworks used for testing, building, etc.
  • API of package grunt-typedoc2md

Changelog

prerequisites

This plugin is independent from any specific version of

• typedoc
• typedoc-plugin-markdown

Nevertheless BOTH packages MUST be installed before running 'grunt-typedoc2md'

getting started

This guide assumes, that you are familiar with the use of npm and grunt.
The plugin can be installed by the following command:

npm install grunt-typedoc2md --save-dev

Once installed, the plugin may be loaded from within your gruntfile:

grunt.loadNpmTasks( "grunt-typedoc2md" );

Setup the task configuration as described below (see usage) and run the task:

grunt typedoc2md

Of cause, the task can be integrated into any complex build process.

usage

The following examples assume that the grunt plugin 'load-grunt-config' is used. Alternatively, the code can of course be integrated into the 'gruntfile.js' file.

// file typedoc2md.js
module.exports = function ( grunt, options ) {
  return {
    options: {
      "config": "./conf/typedoc/typedoc.json"           // MUST be of JSON format
    },
    always: {
    },
    other: {
      "config": "./conf/typedoc/other.typedoc.json",    // MUST be of JSON format
      "typedoc-plugin-markdown": false,                 // In case you explicitly may not want to create markdown ;-)
      "plugin": [ "any", "other", "typedoc", "plugin" ]
    }
  };
};

See typedoc guide for settings, that can be used in typedoc.json.