ci: CIテストの追加、CI連携の強化

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+  workflow_dispatch:
+permissions:
+  contents: write
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: ~/.cache 
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install -r requirements.txt 
+      - run: mkdocs build --strict

.gitignore

@@ -1,6 +1,8 @@
 __pycache__/
 .venv/
 
+site
+
 # IDE / Editor
 .vscode/
 .idea/

docs/content/getting-started/mod-files.md

@@ -59,7 +59,7 @@ dependencies {
 
 Modの起点となるメインクラスです。
 
-[#Modクラス](../component/mod.md) で詳しく解説しています。
+<!-- NOTE: Modクラス解説を追加 -->
 
 ## mods.toml
 

hooks/check.py

@@ -13,6 +13,13 @@ def on_page_markdown(markdown, page, **kwargs):
     path = page.file.src_uri
 
     for annotation in ANNOTATIONS:
-        for m in re.finditer(f'({annotation}): ?(.*)', markdown):
-            log.warning(f"Doc file '{path}' contains {annotation}: {m[0]}")
-
+        for m in re.finditer(f'<!-- ({annotation}): ?(.*) -->', markdown):
+            text = f"Doc file '{path}' contains {annotation}: {m[2]}"
+
+            if(annotation == "NOTE"):
+                log.info(text)
+                print(f"::notice title=mkdocs::{text}")
+                continue
+
+            log.warning(text)
+            print(f"::warning title=mkdocs::{text}")