如何让 link 到索引页出现

Question

我已经开始使用 jsdoc 和 jaguarjs-jsdoc 为我的 API 使用节点生成文档。它工作得很好，我什至可以使用 readme.md 文件生成索引页，但我似乎无法让索引页的 link 出现在搜索栏左上方see example site.

我运行的命令是这样的。 $ ./node_modules/.bin/jsdoc ./README.md ./app/ -r -t ./node_modules/jaguarjs-jsdoc/ -d docs 到目前为止，我在 api 中使用的唯一标记是@namespace、@function 和@member。就像我说的，它们似乎生成良好。 link只是一件小事，却让我很烦。

有什么想法吗？

Answer 1

这可能不是唯一的方法，但我确实找到了解决办法。您可以在生成命令中包含一个配置。

jsdoc -t `path to template` -c `path to config` `files to include`

在该模板中，您可以提供一个应用程序名称

}
  "templates": {
    "applicationName": "The Name",
    ...more configs
  },
  ...more configs
}

该名称将出现在 link 到右上角的索引页中。 link 本身总是生成，但如果它为空则没有多大用处。

如何让 link 到索引页出现

How to get the link to the index page to appear

javascript

jsdoc

jsdoc3