【问题标题】:A better way to organize Docco pages一种更好的方式来组织 Docco 页面
【发布时间】:2015-07-05 16:03:49
【问题描述】:
我有一个大型 Backbone 风格的应用程序(约 100 个文件),我正在尝试选择自动化文档的最佳方法。
我正在尝试使用docco,(使用grunt-docco2)但我遇到了问题。我在左侧列出了所有文件,然后向下通过窗口而无法滚动。是否可以对它们进行分组,也许是下拉样式?
另外,是否可以生成索引页面或其他内容? Docco 似乎做了我想做的 99% 的事情,但是这两件事让我发疯了!
【问题讨论】:
标签:
javascript
backbone.js
gruntjs
documentation-generation
docco
【解决方案1】:
好的,我还没有找到生成可靠目录的方法。
但是,我找到了一种方法来阻止疯狂的滚动。
#jump_page 在 docco.css 中定义的地方,改为:
#jump_page {
padding: 5px 0 3px;
margin: 0 0 25px 25px;
max-height:750px;
overflow: scroll;
}
然后我将更改后的样式表并使用 docco css 选项将其传入。
这不是最好的解决方案,但它会设置最大高度并允许滚动,因此如果您有大量要记录的文件,您可以更快地浏览它们。
【解决方案2】:
现在可能这无关紧要,但是有一个名为Docco Husky的项目,您应该检查一下。就像项目的 Docco。
来自他们的 README.md:
基于 Docco 的用于项目文档的流线型静态站点生成器。 “哈士奇”是因为它比 Docco 更大、更不规则,就像你当年在 Sears 买的哈士奇牛仔裤一样。