MkDocs – プロジェクトドキュメントジェネレータMOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました プロジェクトのドキュメントをどう記述し、どう管理するかは重要な問題です。やってはいけないのは一つのドキュメントにまとめて管理することです。大きな文書は修正しづらく、全体が密に連携するので一つの修正が他に及ぼす影響が分かりづらくなります。 文書はなるべく疎結合に、分割して管理されるべきです。しかもMarkdownフォーマットであればテキストファイルなので更新も検索も用意です。ということでMkDocsを紹介します。 MkDocsの使い方 MkDocsのインストールはpipで行います。 $ pip install mkdocs まずはヘルプを出してみます。 $ mkdocs help MkDocs (version 0.12.2) mkdocs [help|new|build|serve
