为了实现“零代码基础也能维护”,本项目采用了 纯静态 + Markdown 驱动 的架构。
如何更新内容?
- 更新教程/排错指南:直接在
docs/start/或docs/troubleshooting/目录下添加或修改.md文件。 - name: Checkout
- name: Setup Node
- name: Setup Pages
- name: Install dependencies
- name: Build with VitePress
- name: Upload artifact
- name: Deploy to GitHub Pages
2. 发布新版本:打开 docs/.vitepress/data/versions.json,在数组开头追加新的版本对象即可,前端下载页面会自动更新。
自动化部署 (CI/CD)
您可以将本项目推送到 GitHub,并使用 GitHub Actions 自动部署到 GitHub Pages。
在项目根目录创建 .github/workflows/deploy.yml 文件,写入以下内容:
``yaml
name: Deploy VitePress site to Pages
on:
push:
branches: [main]
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
uses: actions/checkout@v3
with:
fetch-depth: 0
uses: actions/setup-node@v3
with:
node-version: 18
uses: actions/configure-pages@v3
run: npm ci
run: npm run docs:build
uses: actions/upload-pages-artifact@v2
with:
path: docs/.vitepress/dist
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
id: deployment
uses: actions/deploy-pages@v2
`
配置完成后,每次向 main` 分支推送修改,GitHub 都会自动帮你把网站构建成纯静态文件并发布上线!