Add GitHub Actions CI/CD workflow for automatic MkDocs documentation building #1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements a complete GitHub Actions CI/CD pipeline for the MkDocs documentation site as requested in the issue. The workflow automatically builds the documentation whenever relevant files are changed.
What's Added
🔧 GitHub Actions Workflow (
.github/workflows/build.yml)docs/**,mkdocs.yml,resources/**, etc.)mkdocs-materialand all required plugins viarequirements.txtmkdocs build --verboseto generate the static site📦 Dependency Management (
requirements.txt)Centralizes all Python dependencies:
📚 Project Documentation (
README.md)Comprehensive documentation covering:
🔧 Configuration Updates
.gitignoreto excludesite/build directoryHow It Works
pip install -r requirements.txtmkdocs build --verboseKey Features
Testing
The workflow has been validated with:
This fully addresses the original requirement: "通过 pip install mkdocs-material 这个项目安装好后,一旦发现上传的文件有任何改变添加等,应该执行 mkdocs build" (After installing the project via pip install mkdocs-material, execute mkdocs build whenever any file changes are detected).
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.