16

私は自分のプロジェクトのドキュメントを書いています。私は自分のプロジェクトをPythonで行いました。しかし、ドキュメントを書き留めるためにjekyllを選択しました。しかし、役立つドキュメントは見つかりませんでした。私の周りには、まだ多くの基本的な質問が動いています。jekyll でテンプレートを生成する方法など。みんな、ヘルプの完全なドキュメントを提案するか、jkeyll を使用したドキュメントに関するアイデアを共有してください。

4

4 に答える 4

37

2014年にはいくつかのテンプレートがあり、私は見ています

2015 追加:

他にもあると思いますが、わかりません。

于 2014-01-18T15:09:52.873 に答える
12

https://github.com/tomjohnson1492/documentation-theme-jekyllのテクニカル ドキュメント用の jekyll テーマを開発しています。

于 2015-02-26T04:27:52.903 に答える
3

Jekyll は非常にブログ志向です。静的な html ページを生成するために使用できますが、ソフトウェア プロジェクトを文書化するのには理想的ではありません (ブログで文書化するつもりがない場合)。

プロジェクトが github でホストされている場合は、現在かなり進歩している github の wiki を使用する方がよいでしょう。

それでもドキュメントを自動的に生成したい場合は、より良い解決策あります。

于 2011-01-11T09:18:19.703 に答える