File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1- # Contributing to AMBD-MC
1+ # Contributing to TestRepo
22
33Thank you for your interest and contributions! To ensure high-quality collaboration, please follow the process below.
44
Original file line number Diff line number Diff line change 1+ name : Build and deploy docs
2+
3+ on :
4+ push :
5+ branches : [ main ]
6+ pull_request :
7+ branches : [ main ]
8+
9+ jobs :
10+ build :
11+ runs-on : ubuntu-latest
12+ steps :
13+ - name : Checkout
14+ uses : actions/checkout@v4
15+
16+ - name : Set up Python
17+ uses : actions/setup-python@v4
18+ with :
19+ python-version : ' 3.10'
20+
21+ - name : Install dependencies
22+ run : |
23+ python -m pip install --upgrade pip
24+ pip install mkdocs-material mkdocs-git-revision-date-localized mkdocs-simple-hooks pymdown-extensions
25+
26+ - name : Build docs
27+ run : |
28+ mkdocs build
29+
30+ - name : Check links (optional)
31+ run : |
32+ pip install lychee-action
33+ # lychee CLI 可用作 link checker;按需替换为 markdown-link-check
34+ # lychee ./site || true
35+
36+ deploy :
37+ needs : build
38+ if : github.ref == 'refs/heads/main' && github.event_name == 'push'
39+ runs-on : ubuntu-latest
40+ steps :
41+ - uses : actions/checkout@v4
42+ - name : Setup Pages
43+ uses : actions/configure-pages@v4
44+ - name : Upload artifact
45+ uses : actions/upload-pages-artifact@v1
46+ with :
47+ path : ./site
48+ - name : Deploy to GitHub Pages
49+ uses : actions/deploy-pages@v1
Original file line number Diff line number Diff line change 1+ site_name : TestRepo Docs
2+ site_description : " TestRepo — 模型与工具文档"
3+ site_author : autoMBD
4+ repo_name : autoMBD/TestRepo
5+ repo_url : https://github.com/autoMBD/TestRepo
6+ nav :
7+ - Home : index.md
8+ - Quick Start : getting-started.md
9+ - Tutorials :
10+ - Quick Tutorial : tutorials/tutorial-quick.md
11+ - Advanced : tutorials/tutorial-advanced.md
12+ - Examples : examples/index.md
13+ - Models :
14+ - MODEL_A : models/MODEL_A.md
15+ - API : api/index.md
16+ - Contributing : contributing.md
17+ - Changelog : changelog.md
18+
19+ theme :
20+ name : material
21+ palette :
22+ primary : ' indigo'
23+ accent : ' indigo'
24+ features :
25+ - navigation.instant
26+ - content.code.copy
27+
28+ markdown_extensions :
29+ - toc :
30+ permalink : true
31+ - admonition
32+ - pymdownx.superfences
33+ - pymdownx.tabbed
34+ plugins :
35+ - search
36+ - git-revision-date-localized :
37+ enable : true
38+ - mkdocs-simple-hooks
Original file line number Diff line number Diff line change 1+ # Ignore Visual Studio Code settings folder
2+ .vscode
Original file line number Diff line number Diff line change 1- # AMBD-MC
1+ # TestRepo
22
33[ ![ License] ( https://img.shields.io/badge/license-MIT-blue.svg )] ( #license )
44[ ![ 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 )
55[ ![ Downloads] ( https://img.shields.io/github/downloads/autoMBD/TestRepo/total )] ( https://github.com/autoMBD/TestRepo/releases )
6- [ ![ Contributors] ( https://img.shields.io/github/contributors/autoMBD/AMBD-MC )] ( #contributors )
6+ [ ![ Contributors] ( https://img.shields.io/github/contributors/autoMBD/TestRepo )] ( #contributors )
77[ ![ Docs] ( https://img.shields.io/badge/docs-available-brightgreen )] ( #docs )
88
99简短一句话描述项目核心价值与场景。
1616## 快速开始(3 步)
17171 . 克隆仓库
1818 ``` bash
19- git clone https://github.com/autoMBD/AMBD-MC .git
20- cd AMBD-MC
19+ git clone https://github.com/autoMBD/TestRepo .git
20+ cd TestRepo
2121 ```
22222 . 安装依赖(举例)
2323 ``` bash
You can’t perform that action at this time.
0 commit comments