Minami

A clean, responsive documentation template theme for JSDoc 3.

Changes in this fork (GDixon/Minami)

• Disables sorting of methods in classes (cb32c8a)
• Moves 'namespaces' above 'classes' in nav and patches linkto for namespace methods (2c4e81)
• Adds copyright text to the footer element (62dc618)
• Adds favicon.ico link element in head (b1df1971)
• Fixes formatting line-height issues for h1 and h2's (daf9e91)
• Adds id to the h2 element in header section (d25fec1)
• Alters margin on H2 element (e740797)
• Adds optional (manual) menu which can be used to define nav items for the readme.md - to use add items to extraNavDetails in config handed to jsdoc (b49d6ad)

• to use this version of Minami in your project: follow the install directions in this document, then replace the defined version with "https://github.com/gdixon/minami/tarball/master" in your package.json file.

...
    "devDependencies": {
       "minami": "https://github.com/gdixon/minami/tarball/master"
    }
...

Uses

• the Taffy Database library
• Underscore Template library
• Montserrat & Helvetica Neue

Install

$ npm install --save-dev minami

Usage

Clone repository to your designated jsdoc template directory, then:

$ jsdoc entry-file.js -t path/to/minami

Node.js Dependency

In your projects package.json file add a generate script:

"script": {
  "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
}

In your .jsdoc.json file, add a template option.

"opts": {
  "template": "node_modules/minami"
}

Example JSDoc Config

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc"]
    },
    "source": {
        "include": ["lib", "package.json", "README.md"],
        "includePattern": ".js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": true,
        "useLongnameInNav": false,
        "showInheritedInNav": true
    },
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8",
        "private": true,
        "recurse": true,
        "template": "./node_modules/minami"
    }
}

Specifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).

License

Licensed under the Apache2 license.