文档贡献指南

在线编辑文档

开源代码托管平台支持在线编辑预览markdown格式的文档，选择需要修改的文件，点击右上角编辑按钮即可在线编辑。页面分左右两屏显示编辑窗口和预览窗口，编辑完成后再提交信息框内输入修改备注信息后点击提交即可完成文档在线编辑更新操作。

在线提交合并请求

提交完成后点击合并请求页签，点击右上角的新建合并请求按钮。在出现的分支选择框中，源分支为您修改文档所在的分支，目标分支为目标仓库的待合入分支。

注意事项

1、文档目录只支持Atx格式标题提取

Markdown支持两种标题的语法，类 Setext 和类 atx 形式。

类 Setext 形式是用底线的形式，利用 = （最高阶标题）和 - （第二阶标题），例如：

  1. This is an H1

  1. This is an H2
  2. -------------</code></pre>

任何数量的 = 和 - 都可以有效果。

类 Atx 形式则是在行首插入 1 到 6 个 # ，对应到标题 1 到 6 阶，例如：

  1. # 这是 H1
  3.     ## 这是 H2
  5.     ###### 这是 H6

文档项目目录目前只能提取Atx的标题，不能提取Setext这样的标题。

2、同一文档内图片不可重名

由于文档项目默认使用统一的文件夹存放图片，因此在上传图片的过程中请特别注意：图片不能重名！否则，新上传的图片将会替换重名的原有图片。

我们正在着手解决这一问题，未更新之前，还请自行为图片命名。