Auto Mkdocsシステムを構築する

Auto Mkdocsシステムとは？

簡単なマークダウン記法によりファイルを更新するだけで、その内容がWebサイトのHTMLコンテンツになるものです。

ここでは、その仕組みを「Auto-Mkdocsシステム」とここでは呼ぶ。

登場人物

• 運用者：ホームページを更新する人
• ユーザ：ホームページを参照する人
• Azure WebApps: Microsoft Azureで利用できるWebAppsのFree版を利用
• DevOps
• DevOps Repos : ファイルを格納するリポジトリ―
• DevOps Pipelines : Mkdocsのビルドを実行するパイプライン

主な流れ

1. 運用者がDevOps Repos(mkdocsプロジェクト)のmarkdownファイルを修正する。
2. 修正をトリガーにmarkdownファイルをmkdocs buildを実行する。
   • 実行結果のうちHTML部分(site)をDevOps Repos(公開用public-site)にコピーする。
3. DevOps Repos(public-site)にファイルが格納されると、WebApps側とファイルが同期される。
4. 以下のサイトに更新内容が反映される。
   • https://tinyapp-mkdocs.azurewebsites.net/index.html

---

構築の流れ

1. 無料のWebサイトを構築します。構築手順はこちらを参考にしてください。

2. Azure DevOpsのリポジトリを構築します。公開用リポジトリと修正用リポジトリの2種類を作成します。構築手順はこちらを参考にしてください。

3. 公開用リポジトリ(HTML用)

4. 修正用リポジトリ(Markdown用)

5. Azure Pipelinesを構築します。構築手順はこちらを参考にしてください。