Ami

JSDoc 3 的干净、响应的文件模板主题.

用途

• taffy 数据库库
• 突出模板库
• 蒙特塞拉特 Helvetica 神经元( H)

安装

$ npm install --save-dev minami

使用量

克隆寄存器到指定的 jsdoc 模板目录,然后:

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

节点.js 依赖性

在您的项目中 package.json 文件添加生成脚本 :

"script": {
  "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
}

在你身边 .jsdoc.json 文件,添加模板选项.

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

实例 JSDoc 配置

{
    "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/minami"
    }
}

指定一个使用 Longname InNav 的编号, 它将是在 Nav( 从类开始) 中显示的最大路径元素数 .

许可证

持Apache2许可证.