填充 JSDoc index.html 页面

Populate JSDoc index.html page

我从 jsdocdocdash 开始,到目前为止一切似乎都很顺利。但是,尽管我的模块等正在慢慢记录,但我还没有想出如何将项目添加到生成的 index.html 文件中。文件中需要什么标记才能将项目生成到根 HTML 文件中?

有关更多参考,左侧导航窗格的顶部是 "Home" link。这就是我问这个问题时所指的。 link 本质上是一个空白页,但下面的所有其他 link 都有评论中的正确文档。

documentation 在如何做到这一点上有些误导。它表示只要 README.md 文件位于您的源目录中,它就会使用它找到的第一个文件作为 index.html 文件。这不完全正确。您还必须指定要使用的 README.md 文件的路径:

jsdoc -c jsdoc.json --readme ./README.md