我有一个大型Backbone风格的应用程序(大约100个文件),我正在努力选择自动化文档的最佳方法。
我正在试用docco(使用grunt-docco2),但我遇到了问题。所有我列出的文件都在左边,然后向下经过窗口,无法滚动。有没有可能把它们分组,也许用下拉列表的方式?
此外,是否可以生成索引页或其他什么?Docco似乎做了我想做的99%的事情,但这两件事让我疯了!
好吧,我还没有找到一种生成实体目录的方法。
然而,我找到了一种方法来停止疯狂的滚动。
如果#jump_page在docco.css中定义,请将其更改为:
#jump_page {
padding: 5px 0 3px;
margin: 0 0 25px 25px;
max-height:750px;
overflow: scroll;
}
然后,我接受了修改后的样式表,并使用docco-css选项将其传入。
这不是最好的解决方案,但它会设置最大高度并允许滚动,所以如果你有太多的文件要记录,你可以更快地浏览它们。
也许这现在已经无关紧要了,但有一个名为Docco Husky的项目,你应该看看它。这就像Docco的项目。
从他们的README.md:
基于Docco的用于项目文档的精简静态站点生成器。"哈士奇"是因为它比Docco更大、更不规则,就像你当年在西尔斯买的哈士奇牛仔裤一样。