我开始使用jsdoc
和docdash
,到目前为止一切似乎都没问题。但是,即使我的模块等正在慢慢记录下来,我也无法弄清楚如何将项目添加到生成的index.html
文件中。要在根HTML文件中生成项目的文件需要什么标记?
如需更多参考,请在左侧导航窗格的顶部显示" Home"链接。当我提出这个问题时,这就是我所说的。该链接基本上是一个空白页面,但是下面的所有其他链接都有来自评论的正确文档。
答案 0 :(得分:0)
documentation在如何做到这一点上有些误导。它说只要README.md文件位于源目录中,它就会使用它找到的第一个文件作为index.html文件。这不完全正确。您还必须指定要使用的README.md文件的路径:
jsdoc -c jsdoc.json --readme ./README.md