Apoc 文档站

在线访问：https://docs.apocfly.com

关于项目

Apocalypse Flyleague (APOCFLY) 是一个完全开源的模拟飞行平台项目，致力于降低搭建与运营专业模拟飞行环境的技术门槛。

技术栈

• VitePress - 现代化静态站点生成器
• Vue 3 - 渐进式 JavaScript 框架
• Markdown - 轻量级标记语言

快速开始

前置要求

• Node.js 18.0 或更高版本
• npm 或 yarn 包管理器
• Git 版本控制系统

克隆仓库

git clone https://github.com/your-org/apoc-docs.git
cd apoc-docs

安装依赖

npm install
# 或使用 yarn
yarn install

本地开发

启动本地开发服务器（支持热重载）：

npm run docs:dev

服务器启动后，访问 http://localhost:5173 查看文档站点。

构建生产版本

npm run docs:build

构建产物将输出到 docs/.vitepress/dist 目录。

维护团队

当前维护者：

• @half-nothing - 项目负责人

历史贡献者

感谢以下成员曾为项目付出的心血：

• @Master_Gui
• @XiaoZhang-store

参与贡献

我们热烈欢迎社区贡献！无论是修复错误、改进文档还是提出新想法，您的参与都将推动项目发展。

贡献流程

1. Fork 本仓库 - 点击右上角 Fork 按钮
2. 克隆到本地 - git clone https://github.com/your-username/apoc-docs.git
3. 创建特性分支 - git checkout -b feature/your-feature-name
4. 提交更改 - git commit -m 'feat: add some feature'
5. 推送到远程 - git push origin feature/your-feature-name
6. 提交 Pull Request - 在 GitHub 上创建 PR

提交规范

我们遵循 Conventional Commits 规范：

• feat: 新增功能
• fix: 修复问题
• docs: 文档更新
• style: 代码格式调整
• refactor: 代码重构
• test: 测试相关
• chore: 构建/工具链更新

贡献建议

• 提交前请运行 npm run docs:dev 确保文档能正常构建
• 保持文档内容简洁清晰，遵循既有风格
• 大型改动建议先开 Issue 讨论
• 尊重社区行为准则，友好交流

许可证

本项目采用 署名—非商业性使用—相同方式共享 4.0 协议国际版 (CC BY-NC-SA 4.0) 授权。

您可以自由地：

• 分享 — 在任何媒介以任何形式复制、发行本作品
• 演绎 — 修改、转换或以本作品为基础进行创作

惟须遵守以下条件：

• 署名 — 您必须给出适当的署名，提供指向本许可协议的链接，同时标明是否（对原始作品）作了修改。您可以用任何合理的方式来署名，但是不得以任何方式暗示许可人为您或您的使用背书。
• 非商业性使用 — 您不得将本作品用于商业目的。
• 相同方式共享 — 如果您再混合、转换或者基于本作品进行创作，您必须基于与原先许可协议相同的许可协议 分发您贡献的作品。
• 没有附加限制 — 您不得适用法律术语或者技术措施从而限制其他人做许可协议允许的事情。

完整许可协议请参见：CC BY-NC-SA 4.0 中文版

---