GitHub ActionsでMkDocsのサイトをGitHub Pagesに自動デプロイしてみた

はじめに

この記事では、「GitHub ActionsでMkDocsのサイトをGitHub Pagesに自動デプロイする方法」について書いています。

GitHub PagesをMKDocsで手軽に作ってみたいなぁと思ったのが記事を書いたきっかけでした。

自分に向けた備忘録の意味もありますが、「GitHub PagesをMKDocsで作ってみたい」な人の一助になれば嬉しいです。

方法

方法としてはとてもシンプルで、GitHub Actionsで以下のようなyamlファイルを作成してあげるだけです。

on:
  push:
    branches:
      - main
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: 3.9
      - run: pip install mkdocs-material
      - run: mkdocs gh-deploy --force

簡単にymlファイルの内容を解説すると

• on:以下の部分では、mainブランチに何かしらpushされた時にこのアクションを実行するように設定しています。
• deploy:以下で自動で実施する処理の内容を記述しています。
• actions/checkout@v2 でリポジトリのコードをチェックアウトします。
• actions/setup-python@v2でpythonの実行環境を設定（構築）します。
• pip install mkdocs-materialでmkdocs-materialをインストールし、コマンドを実行できるようにします。（下の処理を実施させるのに必要）
• mkdocs gh-deploy --forceでデプロイの作業を実施させています。

上記のGitHub Actionのymlファイルを作っておくだけで、次からmainブランチに変更をpushする時に自動でhtml作成からPagesへのデプロイ（内容の更新）までやってくれるようになります。

おわりに

「GitHub ActionsでMkDocsのサイトをGitHub Pagesに自動デプロイする方法」について解説しました。

GitHub Pages x MKDocsで自分のサイトを手軽におしゃれに作ってみてはいかがでしょうか。

さいごに、記事を書く上で参考にしたサイトのリンクを以下に掲載します。合わせて読んでいただくと良いかと思います。

zenn.dev