dmd-grunt-jsdoc2md v1.1.1

dmd-grunt-jsdoc2md

Plugin for dmd and grunt-jsdoc2md which provides an api index and more readable docs.

content

• Getting started guide
• Usage

Changelog

getting started

This guide assumes, you are familiar with the use of npm.

npm install dmd-grunt-jsdoc2md --save-dev

The grunt plugin grunt-jsdoc2md is a dependant of this dmd plugin.

usage

dmd-grunt-jsdoc2md is used, if grunt-jsdoc2md is configured to generate one markdownfile for each sourcefile found within a directory tree.
After all markdowns have been written, all jsdoc metadata of all sourcefiles is enriched, aggregated and passed to dmd-grunt-jsdoc2md for writing an indexfile, which will link (glue) all markdownfiles together.

Imagine the following directory structure for your source files:

--+ src
  + file1.js
  + file2.js
  + subdir1
  |  + subdir1file1.js
  |
  + subdir2
     + subdir2file1.js

Being glued together by a grunt-jsdoc2md configuration like:
(Extract from gruntfile.js)

  "jsdoc2md": {
    "target0": {
      "src":      "src/**/*.js",
      "dest":     "docs/apidir/",
      "options": {
        "index":  {
          "dest": "docs/api.md"
        }
      }
    }
  }

Which will produce the following output:

--+ docs
  + api.md         <= this is the index file (s.a.: "docs/api.md")
  |
  + apidir         <= the api markdown root  (s.a.: "docs/apidir")
    + file1.md
    + file2.md
    + subdir1
    |  + subdir1file1.md
    |
    + subdir2
       + subdir2file1.md

The file api.md will hold a listing of all modules listed above. The modules are correctly linked, so you can navigate from the index file to each of the submodules.