跳转至

如何参与

本项目基于mkdocs-material进行搭建,项目地址uav-wiki

大致流程如下:

  1. uav-wiki仓库 Fork 到自己的仓库中;
  2. 将 Fork 后的分支仓库克隆(clone)到本地;
  3. 在本地进行修改后提交(commit)这些更改;
  4. 将这些更改推送(push)到你克隆的分支仓库;
  5. 提交 Pull Request 至主仓库。

当克隆好后可以先在本地部署查看效果

# 安装依赖
pip install mkdocs-material
# 在本地预览效果
mkdocs serve

所有文档都在docs文件夹下,关于导航页面的设置在mkdocs.yml的nav字段中