通则

  1. 多个连续空格会被会忽略成一个,标题内部,语句内部,单元格内部等都是这样。
  2. 连续空行会被忽略成一行,有些标记语句会无视空行。
  3. 使用标记符包裹的内容和标记符之间不能有空格。
  4. 一般情况下多个连续的标记符之间不能有空格。
  5. 多个标记符可以嵌套使用,例如***~~as~~***显示为斜体加粗带删除线的字体。
  6. 关键字、标签等不区分大小写,标签支持中文。

1. 常用快捷键

功能快捷键
加粗Ctrl + B
斜体Ctrl + I
引用Ctrl + Q
插入链接Ctrl + L
插入代码Ctrl + K
插入图片Ctrl + G
提升标题Ctrl + H
有序列表Ctrl + O
无序列表Ctrl + U
横线Ctrl + R
撤销Ctrl + Z
重做Ctrl + Y

2. 字体基本属性

2.1 粗细

**内容**
__内容__
  1. 使用四个*内容包起来,即可显示加粗格式字体。
  2. 使用四个_内容包起来,即可显示加粗格式字体。
    粗体

注意

  1. 两种方式内容和标记符之间不能有空格。
  2. 使用_时,如果__内容__两端直接连接有文本(标点符号除外),则必。须有空格,显示的时候空格也会显示出来,多个空格会自动忽略成一个 。
  3. 使用***内容**两端可以有空格,显示的时候空格也会显示出来,多个空格会自动忽略成一个。

2.2 删除线

~~内容~~

使用四个~内容包起来,即可显示删除格式字体。
删除字体

2.3 斜体

*内容*
_内容_
  1. 使用两个*内容包起来,即可显示倾斜格式字体。
  2. 使用两个_内容包起来,即可显示倾斜格式字体。
    斜体

注意
使用_时,如果_内容_两端直接连接有文本(标点符号除外),则必须有空格,显示的时候空格也会显示出来,多个空格会自动忽略成一个 。

2.4 下标

~内容~

使用两个~内容包起来,即可显示下标格式字体。
下标

2.5 上标

^内容^

使用两个^内容包起来,即可显示上标格式字体。
上标


3. 显示样式

3.1 目录

@[TOC](主标题)

用来显示主标题及生成目录,目录由#标记的分标题组成根据#数量缩进,即使分标题在1. >中,也会显示,TOC不区分大小写。
目录

3.2 标题

# 一号标题
## 二号标题
###### 六号标题

一号标题
==

二号标题
-------
  1. #越多标题的字体越小,最多支持6级。
  2. 一号标题有两种写法,等效,=数量不限,但必须连续。
  3. 二号标题有两种写法,等效,-数量不限,但必须连续。
  4. 六号标题大小和粗体一样,但是粗体不能做标题,即不会生成目录。
    标题

注意

  1. #标题之间必须有个空格,不显示,多个空格会被自动忽略。
  2. 标题内部多个连续的空格,忽略成一个
  3. #不应有其他文字,但可以有1. >

3.3 按键

<kbd>键名</kbd>

显示按键风格。
按键

3.4 引用

> 引用文本
> > 引用文本
  1. >引用文本可以没有空格,>只对当前行有效。
  2. >> 可以进行引用嵌套,中间可以有空格。
  3. 引用中可以使用markdown的其他语法。
    引用

3.5 标记

==标记文本==

被标记的文本将显示不同的背景色。
标记

3.6 片段

`
  1. ` 是英文输入法下,键盘Tab键上方的那个按键。
  2. 通常使用两个 ` 来标记一行内容。
  3. 通常使用六个 ` 来标记多行内容。
  4. 在片段风格中,其他标记符将失效。
    片段

补充

  1. 标记源码时,需要在 ``` 后标明代码的语法,例如c、c++、Java、bash、shell等。
  2. 显示内容比较长时,片段底部会自动出现滚动条。

3.7 文本框

(4个空格)文本
  1. 在文本前空4个空格也可以实现片段效果,但是无法指明语法。
  2. 空格可以是中英文输入法下的。
  3. 文本框上面一行不能是普通文本,推荐空一行。
  4. 多行文本时,要求每行前都要有4个空格。
  5. 显示内容比较长时,片段底部会自动出现滚动条。
    文本框

3.8 列表

3.8.1 无序列表

- 项目名称
* 项目名称
+ 项目名称

显示时-*+被替换为黑点,-*+项目名称之间必须有空格。
无序项目

3.8.2 有序列表

1. 项目名称

显示时会显示序号,1. 项目名称之间必须有空格,否则将原样输出,不会自动编号。
有序列表

补充

  1. 1. 可以进行指定为不同的数字,但只有第一个项目指定的序号有用,其他的序号在显示的时候自动排序
  2. 项目使用Tab键对齐,上图中项目2和3使用2次Tab键,它和项目1的距离更近一点,项目2和3的序号独立于项目1,但不连续;项目5和6使用一个Tab键,项目序号连续,并独立于项目4。
  3. 在使用列表时,数字后面加上英文的点,就可能无意间产生列表,比如2019.05.18 这时候想表达的是日期,有些软件把它被误认为是列表。解决方式:在每个点前面加上\就可以了。

3.8.3 有序无序混合使用

* 1. 项目名称

这个感觉用不到,貌似还有些问题,*+-表现都一样。
有序无序混合使用

3.8.4 列表和标题混合使用

+ # 标题
1. # 标题
  1. 可以在标题前添加标号,*+-表现都一样。
  2. 我们更倾向于使用# 1. 标题来代替1. # 标题,因为后者标号和标题字体大小不一致,但是前者要手动编号。
    列表和标题混合使用

3.8.5 勾选列表

- [ ] 项目名称1
1. [ ] 项目名称2
- [x] 项目名称3

未勾选时,-1.[]项目名称都有空格,勾选时,[x]之间没有空格,x不区分大小写。
勾选列表

补充

  1. -1.缩进略有区别,其他没有区别。

3.8.6 多级列表

在列表的前面加个Tab键即可构造多级列表。

- 一级列表
	- 二级列表
  • 一级列表
    • 二级列表

4. 插入

4.1 链接

4.1.1 行内形式

[链接文字](链接地址 "标题")

标题是可选项,鼠标经过链接文字时,会显示标题内容。
行内链接

4.1.2 参考形式

[链接文字][链接名称]

[链接名称]:链接地址 "标题"
  1. 为参考行式的链接定一个名称,方便在文章中多次引用。
  2. 链接名称可以是字母、数字和空格,不区分大小写
    参考形式

注意

  1. [链接名称]:链接地址 "标题"上面一行只能是空行或另一个[链接名称]:链接地址 "标题"

4.1.3 自动链接

<链接地址>

将链接地址显示出来,并链接到该地址上,通常用在邮箱地址或简短的网址上。
自动链接

4.1.4 标题链接

[链接名称](#转换后的标题_行号)
  1. 这是TOC的目录链接的方式,且只适用于标题。
  2. 也可以采用上文中参考形式的链接方式。
  3. 转换后的标题需要注意,可以为
  4. 删除标题内除A-Z a-z 0-9 (空格) _外的所有符号。
  5. 标题内部的空格转为_,一对一转换,连续的空格转换为连续的_
  6. 标题内部的_保留原位。
  7. _行号_必须有。
  8. #转换后的标题_行号之间不能有空格。
  9. 行号一定要正确,重新编辑文档后,行号可能会变动,需要重新矫正。
  10. markdown文档的行号从0开始。
  11. 推荐使用标题链接时,看一下TOC生成的标题链接。
    标题链接

4.2 图片

[外链图片转存失败(img-ULNiwuox-1562242653821)(图片地址#pic_center =宽x高)]
  1. 图片文字是可选的,可以缺省,但![]()必须有。
  2. #pic_center是可选的,表示图片居中,必须紧跟图片地址。
  3. 图片地址可以是网络资源
  4. 图片地址也可以是本地资源,同级目录下图片[外链图片转存失败(img-zb46GjB0-1562242653823)(/图片名称)]即可,子目录的话,依次补全路径,也可以写绝对路径。
  5. =宽x高是可选的,可以调整图片大小。
    插入图片

注意

  1. =前****必须有空格。
  2. =宽x高必须连续
  3. x必须是小写的X。

4.3 分割线

***
---
___
  1. 一行内只有*-_一种符号,不含有其他文字,可以有空格。
  2. 有3个及以上该符号,不要求连续,中间可以有空格。
  3. -连续时,其上面不能有普通文本或链接语句,不然会产生标题二的效果,上面可以是# >标记语句,最好空一行,空行不会影响显示。
  4. 三种符号画的分割线等效。
    分割线

4.4 表格

A|B
-|-
1|2
  1. 至少由上面三行构建出一个表格。
  2. 每行两侧的空格和|不影响表格,即 |A | B |A|B等价。
  3. ||表示一个空单元格
  4. A|B是标题行,确定表格显示的列数,可以有空单元格。
  5. AB可以是含有空格的字符串。
  6. -|-确定表格最大列数,A|B的列数超过该最大值时,将构不成表格。
  7. -|-规定该列单元格的对齐方式。
  8. -|-只有第二行的有效,其他行均被解释为普通字符。
  9. -数量不限,不影响表格布局。
  10. -|之间可以有空格,-之间不能有空格。
  11. 构成表格的数据中间不能出现空行。
  12. 1|2这些数据行至少有一个|,只有一个元素时,|可在元素前面或后面。
  13. 数据行列数大于标题行时,后面的数据将不显示
    插入表格

4.4.1 单元格对齐

:-------:居中,默认
:--------靠左
--------:靠右
不限制-的数量,但是:---:--:---:必须连续,两侧可以有空格。

4.4.2 单元格换行

单元格可以使用<br>进行换行,如下

A|B
-|-
1|2<br>3
AB
12
3

4.5 注脚

文本[^注脚名称]
[^注脚名称]: 注释
  1. 注脚就像小学课本上每页底下的注释。
  2. 注脚名称在显示时会被数字代替,进行自动排序,注脚名称可以是字母、数字或汉字。
  3. 注脚名称和注释中标签必须对应好,一个注释可以被多处引用。
  4. 注脚会被自动显示在文章结尾处。
  5. 浏览时,点击注释后面的↩︎,可以跳转到引用处,每个↩︎对应一处引用。
    插入注脚

5. 其他技巧

5.1 换行

<br>
<br/>

该标签也是html语言的换行标签,该标签若单独占一行则表示空出两行,若想空出一行可以在空行上使用缩进/空格
换行

5.2 缩进/空格

&nbsp;
&ensp;
&emsp;
使用**全角**空格

上述缩进语法依次缩进:1/4,1/2,1(单位:中文字符),可以参考。手动输入空格 &nbsp;(全英文输入法,输入几个&nbsp;就表示几个空格)。在全角输入状态下直接使用空格键,如下图圆点:
全角输入模式
缩进

5.3 锚点

<a id="锚点id">锚点名称</a>
[链接名称](#锚点id)

markdown本身不支持锚点,但可以借助html来实现,锚点名称会被颜色标注,也可以为空,可以将名称写在<a id=..>前面避免被标记,可以参考
锚点

5.4 注释

[//]:注释
  1. 有时需要在markdown文档中写句注释,但这句话又不希望显示出来,方法参考
  2. 该方法其实就是参考行式链接里的定义链接的语法,转到参考形式
  3. [//]中的//也可以是其他的文字,但是不要和文内其他链接名称重复了。
    注释

5.5 特殊字符

#: \#
*: \*
`: \`
-: \-

对于特殊字符,使用\转义即可。


参考https://blog.csdn.net/u014061630/article/details/81359144

Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐