javascript - 一种更好的方式来组织 Docco 页面

Question

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

我正在试验docco，（使用grunt-docco2）但我遇到了问题。我在左侧列出了所有文件，然后向下通过窗口而无法滚动。是否可以对它们进行分组，也许是下拉式的？

另外，是否可以生成索引页面或其他内容？Docco 似乎做了我想做的 99% 的事情，但是这两件事让我发疯了！

score 0 · Accepted Answer

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

但是，我找到了阻止疯狂滚动的方法。

#jump_page 在 docco.css 中定义的位置，将其更改为：

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

然后，我将更改后的样式表并使用 docco css 选项将其传入。

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

score 0 · Accepted Answer

现在可能这无关紧要，但是有一个名为Docco Husky的项目，您应该检查一下。这就像项目的 Docco。

从他们的 README.md 中：

基于 Docco 的用于项目文档的流线型静态站点生成器。“赫斯基”是因为它比 Docco 更大、更不规则，就像你当年在 Sears 买的赫斯基牛仔裤一样。

2 回答 2