Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yoshiyasu1111/mkdocs_template
https://github.com/yoshiyasu1111/mkdocs_template
mkdocs
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yoshiyasu1111/mkdocs_template
- Owner: yoshiyasu1111
- License: apache-2.0
- Created: 2022-12-19T06:53:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-19T06:54:46.000Z (about 2 years ago)
- Last Synced: 2024-02-07T06:25:40.807Z (11 months ago)
- Topics: mkdocs
- Language: Dockerfile
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# コンテナのビルド
## 手動でビルドする場合
```bash
$ docker buildx bake -f docker-compose.yml
$ docker compose up -d
```## vscodeのremote containerでビルドする場合
`Open Folder in Container`でルートディレクトリを開く
# mkdocsの使い方
## プロジェクトの作成
```bash
$ mkdocs new test
```## ビルド
```bash
$ cd test/
$ mkdocs build
```## ローカル実行
```bash
$ mkdocs serve
```vscodeのターミナルで事項している場合は`ブラウザで開く`メニューが出てくるのでクリックする。それ以外の環境では`127.0.0.1:8000`にアクセスする。