如何获得链接到索引页面出现

Question

我已经开始使用jsdoc和jaguarjs-jsdoc来为我的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。就像我说的，他们似乎正在生成良好。链接只是一件小事，但它让我很烦恼。

什么想法？

Answer 1

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

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

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

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

这个名字将出现在右上角的链接，索引页。链接本身总是生成的，但如果它是空的，则用处不大。