https://github.com/corrupt952/mkdocs-prj-templates

MkDocsをリポジトリに導入する時のテンプレート
https://github.com/corrupt952/mkdocs-prj-templates

Last synced: 10 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/corrupt952/mkdocs-prj-templates
• Owner: corrupt952
• Created: 2020-02-27T21:20:44.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-27T22:13:05.000Z (almost 5 years ago)
• Last Synced: 2025-01-02T23:05:40.206Z (18 days ago)
• Language: Dockerfile
• Size: 1000 Bytes
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• 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`