Nextpilot Document Website

如何使用

本仓库托管 nextpilot.github.io 托管了NextPilot Document Website网站，包含产品介绍、精彩案例、用户手册、开发指南等内容。

• 官方网站：https://docs.nextpilot.cn

• 用户手册：https://docs.nexpilot.cn/manual

• 开发指南：https://docs.nexpilot.cn/develop

当仓库更新时，Github 基于 .github/workflows/mkdocs-gh-deploy.yml 自动触发编译，并将生成结果推送到 gh-pages分支。

如何编译

NextPilot Document Website 基于 mkdocs 和 mkdocs-material 进行发布的，需要 python3.8 以上版本。

安装mkdocs依赖项

# 升级pip工具
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple --upgrade pip

# 设置PyPi国内镜像源
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple

# 安装mkdocs等依赖项
pip install -r requirements.txt

编译帮助文档

# 下载代码到本地
git clone https://github.com/nextpilot/nextpilot-flight-control.git
# 切换到docs目录
cd nextpilot-flight-control
# 编译文档
mkdocs build
# 或者使用，在浏览器http://127.0.0.1:8063/可以预览效果
mkdocs serve

参考资料

• Material for MkDocs
• MkDocs static i18n plugin documentation，多国语言支持
• mkdocs-literate-nav，使用 SUMMARY.md 创建导航栏
• mkdocs-awesome-nav，使用.nav.yml 自定义导航栏