corrupt952/mkdocs-prj-templates

MkDocsをリポジトリに導入する時のテンプレート

mkdocs-prj-templates

テンプレート

ドキュメント用リポジトリ向け

ドキュメント用リポジトリなので、ルートディレクトリに必要なファイルを配置し、docker-composeで素直に操作するスタイル.

simple

• mkdocs serve ... docker-compose up -d
• mkdocs build ... docker-compose run --rm mkdocs mkdocs build

アプリケーションリポジトリなどドキュメント用途以外のリポジトリに追加する向け

ドキュメント用途以外のリポジトリに追加するため、ファイルが散らからないようにmkdocs.yml以外のファイルをdocsに配置し、bin/docs-compose経由でコマンドを操作を行うスタイル.
mkdocs-excludeでビルド時に、Dockerfileやdocker-compose.yamlが含まれないようにしている.

in-docs

• mkdocs serve ... bin/docs-compose up -d
• mkdocs build ... bin/docs-compose run --rm mkdocs mkdocs build