NetlifyにMkDocsのドキュメントをデプロイする

やること

1. Mkdocsのドキュメントをローカルでテスト
2. Githubにコードをプッシュ
3. Netlifyの設定ファイルをレポジトリに追加
4. Netlifyにプロジェクトを作成
5. ソースにGithubを選択

MkDocsのドキュメントをローカルでテスト

MkDocsのドキュメントをローカルでテストします。

$ mkdocs serve
...
INFO    -  [17:43:43] Serving on http://127.0.0.1:8000/

これで問題無く表示されることを確認します。

Githubにコードをプッシュ

最低限のファイル構成は以下の通りです。 次の手順でnetlifyの設定ファイルを追加します。

$ tree -L 1
.
├── docs
└── mkdocs.yml

Netlifyの設定ファイルをレポジトリに追加

netlify.tomlをレポジトリ直下に追加します。

[build]
  publish = "site"
  command = "mkdocs build -d site"

Netlifyにプロジェクトを作成

Netlifyにプロジェクトを作成します。

• Add new site をクリック
• Import an existing repository を選択
• Githubを選択
• リポジトリを選択

これでデプロイが完了します。