跳转至

运行文档 Operating-document

License: CC BY-NC-SA 4.0 Markdown BuildStateCard LastCommitCard

本项目是一个以Markdown语言以及Zensical文档站(原Material for MkDocs))组成的一个模拟飞行平台运营所集成的所有文档，这包括：

  • 行为准则
  • 管制员考核大纲
  • ......

Roadmap

您可以在我们的github仓库项目中，查阅我们的发展路线

官方讨论渠道

您可以前往我们的github仓库、Discussions板块与我们一同进行讨论，请务必遵守社区行为准则哦

使用指南

  • 将本仓库Fork下来，再用Github page将此项目运营在github服务器上
  • 将本仓库Fork下来，和我们一起对其进行编写！
  • 也可以将此项目部署在本地服务器上

使用Python库

基础库：

Package Version
zensical 0.0.5

依赖库：

Package            Version
------------------ -------
click              8.3.0
colorama           0.4.6
deepmerge          2.0
Markdown           3.10
pip                25.3
Pygments           2.19.2
pymdown-extensions 10.16.1
PyYAML             6.0.3

部署教程

使用zensical进行部署

  1. 确保有python环境(>=3.12)

  2. 克隆本项目到本地 

    git clone https://github.com/apocfly/Operating-document.git

  3. 创建虚拟环境

你也可以使用conda或者pdm之类的包管理软件, 这里我们使用python原生的venv做示范

```shell
python -m venv ./.venv
```

  1. 激活虚拟环境 

    ; cmd
.\.venv\Scripts\activate.bat


    ; powershell
.\.venv\Scripts\activate

  2. 安装所需的库

    pip install -r requirements.txt

  3. 运行开发服务器 

    zensical serve

  4. 进行编写

使用bat脚本部署

  1. 运行项目根目录下的DevEnv-Launcher.bat一键配置环境及打开Vscode

  2. 运行开发服务器

zensical serve
  1. 进行编写

添加requirements.txt

  1. 安装freeze
pip freeze
  1. 生成requirements.txt
pip freeze > requirements.txt

更新Zensical

  1. 前往Github releases查看版本

  2. 更新Zensical

    pip install --upgrade --force-reinstall zensical

  3. 参考添加requirements.txt 更新requirements.txt

贡献方式

您可以将本项目进行 fork，并查看 #3 内的Todo list以查看需要完成的任务

文件分类的说明

本文档站有许多分文件夹，以下将讲述他们的用途：

General - 总则，通适用于任何用户的文件
CTD - 管制员训练部，培训管制员所用到的材料等
    Learning_Center - 学习中心，培训管制员所用到的一些理论资料
PTD - 飞行员训练部，培训飞行员所用到的材料等
Document - 文档，存放上述Markdown文件的docs、pdf格式文件

适用的平台

目前我们已经将这套方案启用于“ISFPFLY 天启模拟飞行平台”上，您可以点此加群。

许可证

本项目的全部文字在 CC BY-SA 4.0(知识共享 署名-相同方式共享 4.0协议) 之条款下提供，附加条款亦可能应用。

本项目采用 [知识共享署名-相同方式共享 4.0 国际许可协议 (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/deed.zh-hans) 授权。

您可以自由地：

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

惟须遵守以下条件：

- **署名** — 您必须给予适当的署名，提供许可协议链接，并指明是否作了修改。
- **相同方式共享** — 若您再混合、转换或者基于本作品进行创作，必须基于与原先许可协议相同的许可分发。

完整协议请参见 [https://creativecommons.org/licenses/by-sa/4.0/deed.zh-hans](https://creativecommons.org/licenses/by-sa/4.0/deed.zh-hans)。

社区行为准则

在CODE_OF_CONDUCT.md中查阅，请注意这里是COC是指Github社区的行为准则，而不同于模拟飞行的COC。