Git操作 wiki QuickStart
- 文档规范
- 统一在Git各项目对应的Wiki上面书写开发文档；
- 不要在Wiki界面中直接编写文档，需要将Wiki(例如：{github-repos}.wiki.git)clone到本地进行编写；
- 使用markdown格式书写文档，推荐使用 Typora编辑器；
- 文件名即是文档标题，文件名需要清晰，有意义；
- 不要随意建目录，注意目录的分类、概括性，尽量不使用多层级目录；
- Wiki首页(home.md)用于书写项目的全局信息、整体架构方案；
- 侧边栏页面(_sidebar.md)用于全部目录索引；
- 各链接不要带.md后缀，只需要文件名即可，否则会打开成一个md的原文件
- 附件资源放在uploads目录下，根据不同归类，可以新建不同的子目录
Github中每个代码库有一个Wiki功能，可以方便的为项目编写相关的Wiki，并且提供了一个可视化编辑界面来编写文档。
注意：查看Wiki需要Guest级别的权限，创建和编辑Wiki页面需要Developer级别。
$ git clone ${代码仓库}.wiki.git
#例子：
$ git clone https://github.com/Bin4xin/bin4xin.github.io.wiki.git然后就会看到一个${代码仓库}.wiki.git的目录，接下来就可以在本地进行编写了，然后通过git提交管理。
Tips:
本地构建demo请参考Jekyll-Quick-Start
或者借用action进行构建sentrylab-blog-Quick-Start
一个标准的wiki目录结构如下:
.
├── uploads/
├── 文档目录1/
├── 文档目录2/
├── _sidebar.md
└── home.md
-
home.md： Wiki的首页，菜单点击Wiki菜单项指向的就是此页面； -
_sidebar.md： Wiki页面的全局侧边栏，如果没有这个文件，则使用默认的侧边栏规则，展示Wiki所有的文档链接。一般我们需要重写此页面，按自己的规划建立好Wiki链接索引； -
uploads/：是Wiki的附件资源上传的路径；把附件都放这个目录，里面可以新建子目录。
Tips：
