格式规范的目的是为了提供统一的书写准则，并使成品文档有更好的阅读体验。
标题使用 #，与上下正文需要使用空行隔开。一级标题使用一个 #，二级标题使用两个 ##，以此类推
正确：
使用 GitHub 登录
Sprite 组件
错误：
使用 github 登录
sprite 组件
正确：
本站点使用 Jekyll 搭建，应用 HPSTR 主题。文章保存在
_posts目录下。
今天出去买菜花了 5000 元
我家的带宽有 1 Gbps，硬盘一共有 10 TB。
错误：
本站点使用Jekyll搭建，应用HPSTR主题。文章保存在
_posts目录下。
今天出去买菜花了5000元
我家的带宽有 1Gbps，硬盘一共有 10TB。
完整的正确用法：
请尽量避免直接使用系统自带的 Ruby，推荐使用 rbenv 来管理本地 Ruby 运行环境，同时使用 ruby-build 来安装 Ruby，现使用的 Ruby 版本为 2.1.1。
正确：
打开 属性检查器 来查看属性
点击 创建按钮 创建新节点
正确：
通过
this.node.scale来设置节点的缩放
this.getComponent(cc.Sprite).spriteFrame可以动态改变节点渲染的图像
保存 Prefab，代码范例如下：
Editor.Ipc.sendToPanel('scene', 'scene:apply-prefab', node.uuid);接下来这里的正文部分需要有一个空行与上面的代码段隔开。
图片格式：。使用半角（halfwidth）英文标点，且 !、[]、() 三者之间不要有空格
eg：
正确：
访问我们网站的最新动态，请 点击这里 进行订阅。
错误:
访问我们网站的最新动态，请点击这里进行订阅。
跳转链接格式：[跳转的文档名称](跳转的文档目录)。使用半角（halfwidth）英文标点，且 [] 与 () 之间不要有空格。
eg：
[监听和发射事件](../scripting/events.md)
注意：跳转到同一个仓库的文档文件名后缀要使用 .md
跳转链接格式：[跳转的参考文档名称](跳转的参考文档路径)。使用半角（halfwidth）英文标点，且 [] 与 () 之间不要有空格
eg：
[TypeScript 官方网站](https://www.typescriptlang.org/)
跳转链接格式：[跳转的文档名称](跳转的文档目录)。使用半角（halfwidth）英文标点，且 [] 与 () 之间不要有空格
eg：
[Mask API](../../../api/zh/classes/Mask.html)
注意：跳转到另一个仓库的文档文件名后缀要使用 .html
换行要使用空行或者 <br> 进行换行，如果使用回车键换行在 gitbook 上没有换行效果。
正确：
嗨！你知道吗？今天前台的小妹跟我说“喵”了哎！
错误：
嗨！你知道吗？今天前台的小妹跟我说"喵"了哎！
嗨！你知道吗?今天前台的小妹跟我说"喵"了哎!
正确：
核磁共振成像（NMRI）是什么原理都不知道？JFGI！
错误：
核磁共振成像(NMRI)是什么原理都不知道？JFGI！
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
正确：
乔帮主那句话怎么说的？“Stay hungry, stay foolish.”
错误：
乔帮主那句话怎么说的？“Stay hungry，stay foolish。”
在文档或界面中，我们需要通过对话的方式与用户产生共鸣。精准、清晰的语言会更容易让用户理解，合适的语气更容易让用户建立信任感。在使用和书写文案时请参考 Ant Design 设计语言 - 文案。
不论中文还是英文文档，所有截图、示意图都不能出现中文，请注意切换至英文版的软件或操作系统进行截图。