JSDoc 3 如何使用我自己的自定义模板？答案

【问题标题】：JSDoc 3 How can I use my own custom templates?JSDoc 3 如何使用我自己的自定义模板？
【发布时间】：2019-01-02 12:57:45
【问题描述】：

我有许多自定义 HTML 模板以及自定义 publish.js 文件来帮助将它们放在一起，位于我的目录 /home/cordonem/bitbucket/workdir/lib/defaults/platform/docs/templates /html 和两个自定义 CSS 文件和一个 HTML 头文件位于我的目录 /home/cordonem/bitbucket/workdir/lib/defaults/platform/docs/templates/html/static .

我想运行 JSDoc 3 并让它使用我的自定义模板集而不是默认模板。我尝试创建您在下面看到的 conf.json 文件以链接到我的模板的正确位置，但它不起作用。如何让 JSDoc 使用我的自定义模板和 CSS 生成文档？

{
"tags": {
    "allowUnknownTags": true
},
"source": {
    "includePattern": ".+\\.js(doc|x)?$",
    "includePattern": ".+\\.c(doc|x)?$",
    "includePattern": ".+\\.h(doc|x)?$",
    "excludePattern": "(^|\\/|\\\\)_"
},
"plugins": [],
"templates": {
    "cleverLinks": false,
    "monospaceLinks": false,
    "default": {
        "outputSourceFiles": true,
        "layoutFile": "./home/cordonem/bitbucket/workdir/lib/defaults/platform/docs/templates/html"
    }
}
}

对此的任何帮助将不胜感激。谢谢。

【问题讨论】：

标签： javascript jsdoc documentation-generation jsdoc3

【解决方案1】：

您可以研究这些链接 configuring-default-template 和 jsdoc 以使用您自己的自定义模板。

我在默认的 jsdoc 模板上使用了docdash。您可以按照docdash's Github 存储库中提到的说明进行操作。为此，您需要在 jsdoc 目录中添加一个额外的 jsdoc.json 文件。例如

MyProject/node_modules/jsdoc$ 树 -L 1

。 ─ jsdoc.json

─ 其他文件

─README.md

─ 模板

【讨论】：