Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yoshiyasu1111/mkdocs_template


https://github.com/yoshiyasu1111/mkdocs_template

mkdocs

Last synced: 3 months ago
JSON representation

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`にアクセスする。