DaoQMan 快速 MarkDown 规范

Posted son9wx

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了DaoQMan 快速 MarkDown 规范相关的知识,希望对你有一定的参考价值。

DaoQMan4MarkDown 俺的文档规范


标题

如同 html 的一些新的规范一样, 只需要一些语义化的双标签应该尽量改为单标签. 如果有怪怪感觉, 可以简单理解为一些设计语言的左闭右开区间.

随笔,

## 我是大标题
### 我是小标题

文章

# 章节
## 大标题
### 小标题

内容块

为了美观, 一段文字需要换行的时候需要隔空一行, 但是这样会使我们文章段落之间的关系并不明显, 官方有一个简单的换行的方法, 仅仅是在这段文字后面加入两行空格.

下面是一个缺少空格的换行:

没有空格的换行
是没有灵魂的换行

下面是一个存在空格的换行:

没有空格的换行
是没有灵魂的换行

下面是在 VsCode 的演示.
技术图片

代码块

代码块需要显示标注高亮方式, 如下:

技术图片

效果如下:

int main()
{
    return 0;
}

标点

文档中的标点统一对齐主体内容加并远离主体上一个空格, 如下.

  1. 主体, 其他内容
  2. 其他内容 <主体> 其他内容
  3. 其他内容 Main 其他内容

其优点是书写时不需要频繁转换中文符号英文符号, 同时在转移到其他软件上不需要担心文档中的.+空格和代码中的.冲突.

流程图数学公式及其他

使用专业的文档软件构建截图

  • Word
  • Visio
  • 等等

以上是关于DaoQMan 快速 MarkDown 规范的主要内容,如果未能解决你的问题,请参考以下文章

快速编写接口api规范文档工具(Markdown)

markdown Triniti后续开发项目的代码规范

在并行位片代码中实现快速计数器

markdown 交易迁移 - 分析片

技巧系列Markdown 极简手册

Markdown 插入图片