@parse/minami

1.0.0 • Public • Published

@parse/minami

The docs template for parse community jsdocs

Uses

Install

$ npm install --save-dev @parse/minami

Usage

Clone repository to your designated jsdoc template directory, then:

$ jsdoc entry-file.js -t @parse/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/@parse/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/@parse/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.

Readme

Keywords

none

Package Sidebar

Install

npm i @parse/minami

Weekly Downloads

604

Version

1.0.0

License

Apache-2.0

Unpacked Size

94.8 kB

Total Files

27

Last publish

Collaborators

  • dplewis
  • davimacedo
  • mtrezza
  • parseadmin