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

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

您可以研究這些鏈接configure-default-template和jsdoc以使用您自己的自定義模板。

我用docdash在默認jsdoc模板。 您可以按照docdash的Github存儲庫中提到的說明進行操作。 為此，您將需要在jsdoc目錄中添加一個額外的jsdoc.json文件。例如

MyProject / node_modules / jsdoc $樹-L 1

。 ─jsdoc.json

─ 其他文件

─README.md

─模板