ci(github actions): reject github style admonitions

syncing docs from readme of repo to this repo's docs requires changing
github style admonitions to docusaurus style ones

Author: NicholasGoh

.github/workflows/test-deploy.yaml

@@ -22,5 +22,17 @@ jobs:
 
       - name: Install dependencies
         run: npm ci
+      - name: Check for GitHub-style admonitions in markdown files
+        run: |
+          # Search for the `> [!` pattern locally in .md and .mdx files
+          files_with_admonitions=$(grep -rl '> \[!' --include='*.md' --include='*.mdx' ./)
+          if [[ -n "$files_with_admonitions" ]]; then
+            echo "Error: Found GitHub-style admonitions (e.g., '> [!') in the following files:"
+            echo "$files_with_admonitions"
+            echo "Please replace them with Docusaurus-compatible admonitions (e.g., ':::note')."
+            exit 1  # Fail the workflow to indicate that GitHub-style admonitions should not be used
+          else
+            echo "No GitHub-style admonitions found. All markdown files are Docusaurus compatible."
+          fi
       - name: Test build website
         run: npm run build