https://github.com/corrupt952/mkdocs-prj-templates
MkDocsをリポジトリに導入する時のテンプレート
https://github.com/corrupt952/mkdocs-prj-templates
Last synced: 4 months ago
JSON representation
MkDocsをリポジトリに導入する時のテンプレート
- Host: GitHub
- URL: https://github.com/corrupt952/mkdocs-prj-templates
- Owner: corrupt952
- Created: 2020-02-27T21:20:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-19T19:42:19.000Z (12 months ago)
- Last Synced: 2026-01-29T20:58:33.116Z (5 months ago)
- Language: Dockerfile
- Size: 1.95 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mkdocs-prj-templates
## テンプレート
### ドキュメント用リポジトリ向け
ドキュメント用リポジトリなので、ルートディレクトリに必要なファイルを配置し、`docker-compose`で素直に操作するスタイル.
[simple](/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](/in-docs)
- `mkdocs serve` ... `bin/docs-compose up -d`
- `mkdocs build` ... `bin/docs-compose run --rm mkdocs mkdocs build`