组织Docco页面的更好方法

时间:2013-08-15 17:19:35

标签: javascript backbone.js gruntjs documentation-generation docco

我有一个大型的Backbone风格的应用程序(~100个文件),我正在尝试选择自动化文档的最佳方法。

我正在尝试使用docco,(使用grunt-docco2),但我遇到了问题。我列出的所有文件都在左边,然后通过窗口向下滚动,无法滚动。是否可以将它们分组,可能是下拉式的风格?

此外,是否可以生成索引页面? Docco似乎做了我想要的99%,但这两件事让我发疯!

2 个答案:

答案 0 :(得分:0)

好的,我还没有找到一种方法来生成可靠的目录。

然而,我找到了一种方法来阻止疯狂的滚动。

在docco.css中定义了#jump_page,将其更改为:

 #jump_page {
    padding: 5px 0 3px;
    margin: 0 0 25px 25px;
    max-height:750px;
    overflow: scroll;
 }

然后我使用了更改的样式表并使用docco css选项传递了它。

这不是最佳解决方案,但它会设置最大高度并允许滚动,因此如果您想要记录大量文件,则可以更快地导航它们。

答案 1 :(得分:0)

可能这与现在无关,但有一个名为Docco Husky的项目,你应该检查一下。就像项目的Docco一样。

来自他们的README.md:

  

基于Docco的简化静态站点生成器,用于项目文档。 “赫斯基”因为它比Docco更大更不规则,就像你今天在Sears买的Husky Jeans一样。