Package Exports

hopsdoc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hopsdoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Hopsdoc

jsdoc theme for hops

Forked from this amazng theme

Uses

Install

$ npm install --save-dev https://github.com/xing/hopsdoc.git

Usage

Clone repository to your designated jsdoc template directory, then:

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

Node.js Dependency

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

"script": {
  "generate-docs": "jsdoc -c .jsdoc.json"
}

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

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

Example JSDoc Config

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc"]
    },
    "source": {
        "include": ["src", "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/hopsdoc"
    }
}

License

Licensed under the Apache2 license.