agility-jsdoc-template

1.0.3 • Public • Published

Build Status

Agility JsDoc Template

A clean, responsive documentation template theme for JSDoc 3. This has been customized for use with Agility.

Live Demo

Install

$ npm install --save-dev agility-jsdoc-template

Usage

Clone repository to your designated jsdoc template directory, then:

$ jsdoc entry-file.js -t path/to/agility-jsdoc-template

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/agility-jsdoc-template"
}

Example JSDoc Config

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

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 agility-jsdoc-template

Weekly Downloads

1

Version

1.0.3

License

none

Unpacked Size

1.57 MB

Total Files

54

Last publish

Collaborators

  • simpslandyy
  • 1trankev
  • mohit.vashishtha
  • dakotahgodfrey
  • joelvarty
  • jamesvidler