Merge pull request #13 from autoMBD/12-add-docs

12 add docs

Author: TkungAI

.github/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to AMBD-MC
+# Contributing to TestRepo
 
 Thank you for your interest and contributions! To ensure high-quality collaboration, please follow the process below.
 

.github/workflows/github_workflows_ci.yml

@@ -45,13 +45,4 @@ jobs:
             pytest -q || { echo "pytest failed"; exit 1; }
           else
             echo "No tests/ directory found, skipping pytest."
-          fi
-
-      - name: Build docs if mkdocs.yml exists
-        run: |
-          if [ -f "mkdocs.yml" ]; then
-            python -m pip install mkdocs
-            mkdocs build
-          else
-            echo "No mkdocs.yml, skipping docs build."
           fi

.github/workflows/github_workflows_deploy-docs.yml

@@ -0,0 +1,75 @@
+name: Build and deploy docs
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs-material
+
+      - name: Build docs
+        run: |
+          mkdocs build --verbose
+
+      - name: Check site directory
+        run: |
+          ls -la
+          test -d site || (echo "site directory not found" && exit 1)
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Check links (optional)
+        run: |
+          npm install -g markdown-link-check
+          # 检查docs目录下的所有markdown文件，忽略错误
+          find ./docs -name "*.md" -exec markdown-link-check {} \; || true
+
+      - name: Upload site artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: site
+          path: site
+          retention-days: 1
+
+  deploy:
+    needs: build
+    if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || (github.event_name == 'pull_request' && github.base_ref == 'main')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: site
+          path: site
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,5 @@
+# Ignore Visual Studio Code settings folder
+.vscode
+
+# Ignore test build directory
+_test_build/

README.md

@@ -1,8 +1,9 @@
-# AMBD-MC
+# TestRepo
 
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](#license)
 [![CI](https://github.com/autoMBD/TestRepo/actions/workflows/github_workflows_ci.yml/badge.svg)](https://github.com/autoMBD/TestRepo/actions/workflows/github_workflows_ci.yml)
-[![Contributors](https://img.shields.io/github/contributors/autoMBD/AMBD-MC)](#contributors)
+[![Downloads](https://img.shields.io/github/downloads/autoMBD/TestRepo/total)](https://github.com/autoMBD/TestRepo/releases)
+[![Contributors](https://img.shields.io/github/contributors/autoMBD/TestRepo)](#contributors)
 [![Docs](https://img.shields.io/badge/docs-available-brightgreen)](#docs)
 
 简短一句话描述项目核心价值与场景。
@@ -15,8 +16,8 @@
 ## 快速开始（3 步）
 1. 克隆仓库
    ```bash
-   git clone https://github.com/autoMBD/AMBD-MC.git
-   cd AMBD-MC
+   git clone https://github.com/autoMBD/TestRepo.git
+   cd TestRepo
    ```
 2. 安装依赖（举例）
    ```bash
@@ -49,4 +50,4 @@
 （可补充联系方式）
 
 ## License
-本项目采用 MIT 许可证，详见 LICENSE 文件。
+本项目采用 MIT 许可证，详见 LICENSE 文件。