mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-05-07 06:22:51 +08:00
bc3d03de7e
- 新建 docs-site/ Docusaurus 项目，支持 en + zh-Hans 双语 - 从 README 迁移内容为独立文档页面： - Getting Started（安装、快速开始） - Deployment（Docker、裸机、Nginx、配置参考） - Features（备份类型、存储后端、SAP HANA、多节点集群、通知） - Reference（API、CLI） - Development（开发、贡献） - 自定义 BackupX 主题色、logo、落地页组件 - 新增 .github/workflows/docs.yml，Actions 自动构建并发布到 GitHub Pages - README.md 切换为英文，中文版挪到 README.zh-CN.md，两者均精简为导航型 - 配置站点 URL：https://awuqing.github.io/BackupX/
64 lines
1.4 KiB
YAML
64 lines
1.4 KiB
YAML
name: Deploy Docs
|
||
|
||
# 触发条件：
|
||
# - 推送 main 时，如果 docs-site/ 或站点相关 README 有变化
|
||
# - 手动触发（在 Actions 页面）
|
||
on:
|
||
push:
|
||
branches:
|
||
- main
|
||
paths:
|
||
- 'docs-site/**'
|
||
- '.github/workflows/docs.yml'
|
||
workflow_dispatch:
|
||
|
||
# 允许写入 Pages，用于发布到 github.com/Awuqing/BackupX 的 Pages 站点
|
||
permissions:
|
||
contents: read
|
||
pages: write
|
||
id-token: write
|
||
|
||
# 同时只保留一个部署任务
|
||
concurrency:
|
||
group: pages-${{ github.ref }}
|
||
cancel-in-progress: true
|
||
|
||
jobs:
|
||
build:
|
||
runs-on: ubuntu-latest
|
||
defaults:
|
||
run:
|
||
working-directory: docs-site
|
||
steps:
|
||
- name: Checkout
|
||
uses: actions/checkout@v4
|
||
|
||
- name: Setup Node.js
|
||
uses: actions/setup-node@v4
|
||
with:
|
||
node-version: '20'
|
||
cache: 'npm'
|
||
cache-dependency-path: docs-site/package-lock.json
|
||
|
||
- name: Install dependencies
|
||
run: npm ci
|
||
|
||
- name: Build site
|
||
run: npm run build
|
||
|
||
- name: Upload artifact
|
||
uses: actions/upload-pages-artifact@v3
|
||
with:
|
||
path: docs-site/build
|
||
|
||
deploy:
|
||
needs: build
|
||
runs-on: ubuntu-latest
|
||
environment:
|
||
name: github-pages
|
||
url: ${{ steps.deployment.outputs.page_url }}
|
||
steps:
|
||
- name: Deploy to GitHub Pages
|
||
id: deployment
|
||
uses: actions/deploy-pages@v4
|