javascript - Docco ページを整理するためのより良い方法

Question

大規模なバックボーンスタイルのアプリケーション (最大 100 ファイル) があり、ドキュメントを自動化するための最適な方法を選択しようとしています。

docco ( grunt-docco2 を使用 )を試していますが、問題が発生しています。私が持っているすべてのファイルを左側にリストしてから、スクロールする方法がないままウィンドウを通り過ぎます。おそらくドロップダウンのスタイルで、それらをグループ化することは可能ですか?

また、インデックスページなどを生成してもらうことは可能でしょうか? Docco は私が望むすべてのことの 99% を行うようですが、この 2 つのことが私を夢中にさせています!

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 よりも大きくて不規則であるためです。昔、シアーズで購入したハスキージーンズのようです。

2 に答える 2