api-jsdoc v1.0.0

doc-api

A Web API documentation generator based on JSDoc and docdash template theme.

Install

$ npm install jsdoc
$ npm install api-jsdoc

Usage

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

"script": {
  "docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}

Add jsdoc.json file in your project.

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "include": "../js",
        "includePattern": "\\.js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "node_modules/api-jsdoc/events",
        "node_modules/api-jsdoc/tags",
        "plugins/markdown"
    ],
    "opts": {
        "template": "node_modules/docdash",
        "encoding": "utf8",
        "destination": "docs/",
        "recurse": true,
        "verbose": true
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    }
}

License

Licensed under the Apache License, version 2.0. (see Apache-2.0).