喜爱云团队的内部技术文档中心,包含项目部署、开发指南等内容。
# 安装依赖
npm install
# 启动开发服务器
npm run docs:dev
# 构建文档
npm run docs:build
# 预览构建结果
npm run docs:preview本项目使用 GitHub Actions 自动部署到 GitHub Pages,支持以下特性:
- ✅ 自动构建和部署
- ✅ 访问控制(开发人员专用)
- ✅ 响应式设计
- ✅ 全文搜索
- ✅ 深度目录导航
为保护内部文档,本站点启用了访问控制机制:
- 访问部署后的网站
- 输入有效的访问码
- 验证成功后即可正常浏览文档
xiaiyun2024- 主访问码dev-team-access- 开发团队访问码docs-viewer-2024- 文档查看者访问码
本地开发环境 (localhost) 自动跳过认证检查,无需输入访问码。
xiaiyun-docs/
├── docs/
│ ├── .vitepress/
│ │ ├── config.js # VitePress 配置
│ │ └── theme/ # 自定义主题
│ ├── public/
│ │ └── auth.html # 认证页面
│ ├── deployment/ # 部署文档
│ └── index.md # 首页
├── .github/
│ └── workflows/
│ └── deploy.yml # GitHub Actions 部署配置
└── README.md
- 在 GitHub 仓库中启用 Pages 功能
- 设置 Source 为 "GitHub Actions"
- 推送代码到
main或master分支自动触发部署
如需修改访问码,请编辑 docs/public/auth.html 文件中的 ACCESS_CODES 数组:
const ACCESS_CODES = [
'your-new-access-code',
'another-access-code'
];- 定期更换访问码 - 建议每季度更换一次访问码
- 访问记录监控 - 关注 GitHub Pages 的访问统计
- 团队成员管理 - 及时更新离职成员的访问权限
- 代码审查 - 所有文档更改都需要经过代码审查
- 在对应目录下创建
.md文件 - 更新
docs/.vitepress/config.js中的侧边栏配置 - 提交并推送到远程仓库
- 使用 Markdown 格式编写
- 支持 VitePress 扩展语法
- 图片资源放在
docs/public/images/目录
# 标题
## 子标题
::: tip 提示
这是一个提示框
:::
::: warning 警告
这是一个警告框
:::
::: danger 危险
这是一个危险提示框
:::- 文档框架: VitePress 1.6.3
- 构建工具: Vite
- 部署平台: GitHub Pages
- CI/CD: GitHub Actions
- 认证方案: 前端 JavaScript 验证
- 开发团队: 喜爱云技术团队
- 问题反馈: 请在 GitHub Issues 中提交
- 访问码申请: 联系项目管理员
- 本文档包含敏感的部署和配置信息
- 请勿将访问码分享给非授权人员
- 发现安全问题请立即联系开发团队# Force redeploy 2025年 7月28日 星期一 18时49分35秒 CST