OpenIDCS Documents

OpenIDCS · 开源 IDC 虚拟化统一管理平台 —— 官方文档站

本仓库是 OpenIDCS 项目的官方文档站源码，基于 Vite + VitePress 构建，通过 GitHub Actions 自动部署到 GitHub Pages。

---

🛠 技术栈

能力	方案
构建工具	Vite 5
文档框架	VitePress 1.x
前端框架	Vue 3
包管理	npm (Node.js ≥ 18)
国际化	VitePress i18n（简体中文 / English）
全文检索	VitePress Local Search
部署	GitHub Actions + GitHub Pages

---

📁 目录结构

Documents/
├── docs/                      # 文档源目录（VitePress srcDir）
│   ├── .vitepress/
│   │   └── config.ts          # VitePress 主配置（导航 / 侧边栏 / i18n）
│   ├── public/                # 静态资源（logo / favicon 等）
│   ├── index.md               # 中文首页
│   ├── guide/                 # 指南
│   ├── config/                # 配置
│   ├── vm/                    # 虚拟化平台
│   ├── tutorials/             # 功能教程
│   ├── about/                 # 关于
│   └── en/                    # 英文版（与中文版同构）
├── .github/workflows/
│   └── deploy.yml             # GitHub Actions 构建 & 部署
├── package.json
├── tsconfig.json
└── README.md

---

🚀 本地开发

前置要求

• Node.js ≥ 18
• npm ≥ 9（或 pnpm / yarn 自行适配）

启动步骤

# 1. 安装依赖
npm install

# 2. 启动开发服务器（默认 http://localhost:5173）
npm run dev

# 3. 生产构建（产物：docs/.vitepress/dist）
npm run build

# 4. 本地预览构建产物
npm run preview

# 5. 清理构建缓存
npm run clean

---

✍️ 编写文档

1. 在 docs/ 下新建或修改 .md 文件即可。
2. 中文版文件位于 docs/ 根目录；英文版对应放置在 docs/en/ 下的同名路径。
3. 修改导航与侧边栏：编辑 docs/.vitepress/config.ts 中的 zhNav / zhSidebar / enNav / enSidebar。
4. 提交到 main 分支后，GitHub Actions 会自动构建并发布到 GitHub Pages。

---

🌐 GitHub Pages 部署

1. 在 GitHub 仓库 Settings → Pages 中将 Source 设置为 GitHub Actions。
2. 推送代码到 main 分支，工作流 .github/workflows/deploy.yml 会自动触发：
   • build 作业：npm ci → npm run build → 上传 docs/.vitepress/dist artifact。
   • deploy 作业：使用 actions/deploy-pages@v4 发布。
3. 发布地址默认：https://<org>.github.io/Documents/，配置中 base = '/Documents/' 已经适配。
4. 若部署在自定义域名或非子路径，请修改 docs/.vitepress/config.ts 中的 base。

---

📦 相关仓库

• OpenIDCS-Client · 核心管理平台
• Documents · 本文档站仓库

---

📄 开源协议

本文档内容基于 AGPLv3 发布。Copyright © 2024-present OpenIDCS Team.