排版规约

1 一级标题

章标题居中,三号黑体,为了避免标题与正文差异较大,统一顺延,这里使用##。后续标题应循序渐进,不能直接出现三级标题。

1.1 二级标题

章下为节,节标题四号黑体,使用###

1.1.1 三级标题

节下为小节,小节标题小四黑体,使用####

1.1.1.1 四级标题
1.1.1.1.1 五级标题

一般只使用一二三级标题,不自动生成而应自行按序标号。

2 列表

2.1 无序列表

无序列表在符号-后加空格使用:

  • 无序列表 1
  • 无序列表 2
  • 无序列表 3

如果要控制列表的层级,则需要在符号-前使用空格:

  • 无序列表 1
  • 无序列表 2
    • 无序列表 2.1
    • 无序列表 2.2

适用于对条文内容采用分行并叙, 或结构有层级关系。列举结束必须换行

2.2 有序列表

有序列表的使用,在数字及符号.后加空格后输入内容,如下:

  1. 有序列表 1
  2. 有序列表 2
  3. 有序列表 3

适用于表达同步顺序关系。

2.3 分段并叙

故当文章结构复杂,小节以下的标题使用以下方式:

(1) 如果列表其后内容新起一个段落,则需要换行,由于对列表分段换行后会失序,且统一缩进会导致需要通屏展示的内容(如代码块)产生挤压。

(2) 加粗手动标号,依次用**(1)****(2)**……,或者**1)****a)**

(3) 标号(标题)与段落内容之间要加空格

3 引用

引用的格式是在符号>后面书写文字。如下:

疫情就是命令,防控就是责任。 ——领袖

用于大段原文引用,引用结束必须换行

4 文本

4.1 粗体和斜体

用粗体标识段落内强调项一般只在英文中使用斜体用粗体加斜体标识注意项
如果信息之间关联性越高,它们之间的距离就应该越接近,也越像一个视觉单元;反之,则它们的距离就应该越远,也越像多个视觉单元。亲密性的根本目的是实现组织性,让用户对页面结构和信息层次一目了然。

正如「格式塔学派」中的连续律(Law of Continuity)所描述的,在知觉过程中人们往往倾向于使知觉对象的直线继续成为直线,使曲线继续成为曲线。在界面设计中,将元素进行对齐,既符合用户的认知特性,也能引导视觉流向,让用户更流畅地接收信息[1]

4.2 分割线

可以在一行中用三个以上的减号来建立一个分隔线,同时需要在分隔线的上面空一行。如下:


4.3 删除线

删除线的使用,在需要删除的文字前后各使用两个~,如下:

新冠肺炎

5 插入

5.1 链接

一个在hexo博客中插入豆瓣读书的npm包

5.2 脚注

要在标点符号之前使用[2],用于备注,或综合原文得到的结论。注解会自动生成在最后,但仍应统一写在最后。要注意序号与文中位置先后一致。

6 表格

可以使用冒号来定义表格的对齐方式,如下:

居中左对齐右对齐备注
山西1331332
湖北67790529602895
意大利17660143980539

7 代码块

如果在一个行内需要引用代码,只要用反引号引起来就好,如下:

Use the printf() function.

在需要高亮的代码块的前一行及后一行使用三个反引号,同时第一行反引号后面表示代码块所使用的语言,如下:

1
2
3
4
5
6
7
//要写清文件位置信息
public class HelloWorld {
// 行间注释
public static void main(String[] args) {
System.out.println("Hello,World!"); // 行内注释
}
}

diff:

1
2
+ 新增项
- 删除项

html:

1
2
3
<span style="display:block;text-align:left;color:rgb(255, 0, 54);">天猫红居左</span>
<span style="display:block;text-align:right;color:#ff6a00;">阿里橙居右</span>
<span style="display:block;text-align:center;color:#019fe8;">支付宝蓝居中</span>

8 数学公式

8.1 可用

8.1.1 公式:

8.1.2 分式:

8.1.3 化学公式:

8.1.4 块公式:

8.1.5 内联公式

开头的$必须在其右边紧跟一个非空格字符,而结尾的$必须在其左边紧接一个非空格字符,并且不能紧跟一个数字。

8.1.6 希腊字母

对于希腊字母,用 来表示。

8.1.7 上下标

分别使用 ^ 和 _ 实现,比如: = ; = ; =

开根号

字母顶部

  • ,
  • ,
  • ,

8.1.8 括号

圆括号和方括号 =
花括号需要用{和}表示,比如 =
遇到高度较高的分数,括号会变小,如 = ,可以使用\left(…\right)可以自动调整括号的行高,比如 =

8.1.9 求和、极限与积分

= ,= , =
= , = , =

8.1.10 特殊函数

初等函数

8.1.11 特殊符号

  • or

8.1.12 纯文本

单空格, 多空格

8.2 可能有误

8.2.1 等式断行:

8.2.2 方程断行编号:

8.2.3 多列式断行编号:

8.2.4 矩阵断行:

8.2.5 分支等式换行

8.2.6 表格式数组

9 媒体

9.1 图片

图9-1 这里写图片描述

支持 jpg、png、gif、svg 等图片格式,svg 文件示例如下:

图9-2 i_am_svg_20191024083453

使用外部图片时,必须在图片下方或文末标明来源[3]

10 特殊

一般不使用,除非万不得已

10.1 解析HTML

天猫红居左
阿里橙居右
支付宝蓝居中

11 规范检查

在文章内容定稿后,同前端开发中的eslint,应该进行编写规范检查,Markdown 常用代码规范检查工具如下[4]

工具用途lint命令支持IDE
remarkMarkdown 通用规范remark -f docs/VSCode
lint-mdMarkdown 中文规范lint-md docs/VSCode

一般以中文为主,故使用lint-md,其中涵盖了中英文混写的规范。但注意其检查结果仅做参考,应以实际效果为先。


参 考 文 献

  1. Ant design.设计模式[EB/OL].https://ant.design/docs/spec/introduce-cn .2020 ↩︎

  2. Github.Mastering Markdown[EB/OL].https://guides.github.com/features/mastering-markdown/ .2014 ↩︎

  3. 阮一峰.中文技术文档规范[EB/OL].https://github.com/ruanyf/document-style-guide. 2019 ↩︎

  4. Coding.Markdown 代码规范[EB/OL].https://help.coding.net/docs/devops/ci/lint/markdown.html. 2020 ↩︎

更新于
本文字数: 2.7k