Question

我有很多自定义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"
    }
}
}

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

Answer 1

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

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

MyProject / node_modules / jsdoc $树-L 1

。 ─ jsdoc.json

─其他文件

─README.md

─模板

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

1 个答案: