【问题标题】:How to get the link to the index page to appear如何让索引页面的链接出现
【发布时间】:2016-02-15 05:32:09
【问题描述】:

我已经开始使用带有 jaguarjs-jsdoc 的 jsdoc 来使用 node.js 为我的 API 生成文档。它工作得很好,我什至可以使用 readme.md 文件来生成索引页面,但我似乎无法让索引页面的链接出现在搜索栏上方的左上方see example site

我正在运行的命令如下所示。 $ ./node_modules/.bin/jsdoc ./README.md ./app/ -r -t ./node_modules/jaguarjs-jsdoc/ -d docs 到目前为止,我在 api 中使用的唯一标签是 @namespace、@function 和 @member。就像我说的,它们似乎生成得很好。链接只是一个小东西,但它让我很烦。

有什么想法吗?

【问题讨论】:

  • 另外,jsdoc (v3.4.0) 和 jaguarjs-jsdoc (v0.0.1) 都已使用 npm 安装在本地

标签: javascript jsdoc jsdoc3


【解决方案1】:

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

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

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

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

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

【讨论】:

    猜你喜欢
    • 2010-11-17
    • 1970-01-01
    • 2014-09-26
    • 1970-01-01
    • 1970-01-01
    • 2012-05-20
    • 2017-05-14
    • 2010-10-03
    • 1970-01-01
    相关资源
    最近更新 更多