コンテンツにスキップ

MkDocs基本

ビルド

プロジェクトのディレクトリで

1
mkdocs build

ローカルサーバーで確認

プロジェクトのディレクトリで

1
mkdocs serve

サーバー実行中はファイルの追加や変更が検出されて自動でビルドされる

ローカルサーバーを終了する

起動中のコマンドプロンプトでCtrl+Cする。

GitHubにデプロイ

1
mkdocs gh-deploy

実行してからサイトに反映されるまでちょっと時間がかかる。

参考にしたサイト

https://qiita.com/mebiusbox2/items/a61d42878266af969e3c https://jitaku.work/it/mkdocs/install/