mc

minami_customized

Customized minami template for jsDoc, used for better describe Sails.js api

Showing:

Popularity

Downloads/wk

8

Maintenance

No Maintenance Data Available

Package

Dependencies

0

Size (min+gzip)

3.3KB

License

Apache-2.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Minami template, customized to better describe Sails.js structure:

  • models described as classes of module:Models
  • controllers described as classes of module:Controllers
  • etc ...

UI translated to russian. [not full translation]

All parts forked from original minami module

A clean, responsive documentation template theme for JSDoc 3.

Customized theme:

Minami customized Screenshot

Original theme:

Minami Screenshot

Uses

Install

$ npm install --save-dev minami_customized  

Usage

Clone repository to your designated jsdoc template directory, then:

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

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_customized  "
}

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
    },
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8",
        "private": true,
        "recurse": true,
        "template": "./node_modules/minami_customized  "
    }
}

License

Licensed under the Apache2 license.

Originaly forked from Minami

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100