美文网首页程序员
ABP中国组的Git.md文档排版规范.md 2019-01-0

ABP中国组的Git.md文档排版规范.md 2019-01-0

作者: 帕瓦罗地瓜 | 来源:发表于2019-01-08 12:21 被阅读8次

为了使得文档更美观、便于阅读,现统一MD文档排版规范,请大家自觉遵守。谢谢。

  • 保持各级标题的数字序号,如:1.1.3 ABP适用的场景。

  • 文件格式为md,如:1.1 ABP领域层—实体.md。

  • 文件名格式:数字序号 章标题—节标题.md,如:1.1 ABP领域层—实体.md。

  • 内容首行为节标题,即文件名,如:3.1 ABP 领域层—实体。格式为二级标题##,如:## 3.1 ABP 领域层—实体.

  • 标题格式:

    如:

    节标题 ---> 二级标题## 如:## 3.1 ABP 领域层—实体

    1级标题 ---> 三级标题### 如:### 3.1.1 实体类

    2级标题 ---> 四级标题#### 如:#### 1. 审计(Auditing)

    若有更低级标题,请依次类推。

  • 正文:

    段落开始请顶格,无需留空。

    正文部分除注意、编者注、译者注等特别说明外,不要使用特殊格式

    注意、编者注、译者注等特殊说明,请使用引用格式>

  • 代码段请使用"```"格式,如:

    //这是一些代码
    

相关文章

网友评论

    本文标题:ABP中国组的Git.md文档排版规范.md 2019-01-0

    本文链接:https://www.haomeiwen.com/subject/yeuvrqtx.html