# IGXE IOS开发指南

---

## Changelog
### 0.0.1 <small>2022-04-15</small>
- 初始化文档



## 文档编写指南
本项目使用[mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/)开发，如果只是编写文档无需安装python环境，只需要编辑器支持markdown即可

mkdocs-material是[MkDocs](https://www.mkdocs.org/)的样式包,增加了很多独有的样式和插件，点击查看[官方文档](https://squidfunk.github.io/mkdocs-material/getting-started/)

### 本地安装mkdocs-material
=== "Windows"

    ``` bash
    pip3 install -r .\requirements.txt
    mkdoc serve
    ```

=== "MacOS Linux"

    ``` bash
    pip3 install -r ./requirements.txt
    mkdoc serve
    ```

浏览器打开 [http://127.0.0.1:8000/](http://127.0.0.1:8000/) 进行实时预览
### 文档结构

``` bash
│  .editorconfig
│  .gitignore
│  mkdocs.yml //mkdocs，导航栏配置
│  README.md
│  requirements.txt // 项目依赖
│
└─docs // 文档都放在这个目录
    │  code-review.md
    │  git.md
    │  index.md
    │  ...
    │
    │
    ├─assets //存放静态资源文件
    │  ├─images //存放图片
    │  └─screenshots //存放截图，需要按照文档结构创建相应的文件夹存放图片
    │      └─ios
    │              screenshots.png
    │
    ├─ios //存放IOS开发相关的文档
    │
    │
    │
    └─python //存放python开发相关的文档
```

## 参考

---

* [Google Style Guide](https://github.com/google/styleguide)