GitHub ActionsでMkDocsをGitHub Pagesへデプロイ

Author: Hitamuki

.github/workflows/documents.yml

@@ -0,0 +1,38 @@
+name: MkDocs Deploy
+on:
+  push:
+    branches:
+      - develop 
+      - main
+    paths:
+        - 'docs/**'
+permissions:
+  contents: write
+jobs:
+  # https://github.com/marketplace/actions/mkdocs-deployment
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.12.6
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+    - name: Install MkDocs
+      run: pip install mkdocs
+    - name: Build MkDocs
+      run: cd docs && mkdocs build
+    - name: Deploy to GitHub Pages
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        branch: gh-pages  # デプロイ先のブランチ
+        folder: site  # ビルド結果のディレクトリ
+        token: ${{ secrets.GITHUB_TOKEN }}
+  # deploy:
+  #   runs-on: ubuntu-20.04
+  #   steps:
+  #   - name: Configure Pages
+  #     uses: actions/[email protected]
+  #   - name: Deploy to Pages
+  #     uses: actions/[email protected]

docs/.vscode/extensions.json

@@ -13,5 +13,6 @@
     "jebbs.plantuml",
     "hediet.vscode-drawio",
     "figma.figma-vscode-extension",
+    "redhat.vscode-yaml",
   ]
 }