如何获取要显示的索引页面的链接

Question

我已经开始使用jsdoc和jaguarjs-jsdoc来为我的API生成使用node的文档。它工作得很好，我甚至可以使用readme.md文件来生成索引页面但我似乎无法获得索引页面的链接显示在搜索栏上方的左上角{{3} }。

我正在运行的命令看起来像这样。 $ ./node_modules/.bin/jsdoc ./README.md ./app/ -r -t ./node_modules/jaguarjs-jsdoc/ -d docs 到目前为止我在api中使用的唯一标签是@namespace，@ function和@member。就像我说的那样，它们似乎很好。链接只是一件小事，但它让我感到烦恼。

任何想法？

Answer 1

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

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

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

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

该名称将显示在右上角索引页面的链接中。链接本身总是生成但如果它是空的则没什么用。