基础语法
标题
# + 空格 + 标题内容
语法说明如下:
- 在行首插入 # 可标记出标题。
- #的个数表示了标题的等级。
- 建议在#后加一个空格。
- Markdown 中最多只支持前六级标题。
使用规范
-
要保持间距,建议标题的前后都要空1行(除非标题在文档开头);# 与标题文本之间也要有 1 个空格,否则会导致阅读困难。
-
不要有多余的空格。建议标题要写在一行的开头,结尾也不要有空格。
-
建议标题的结尾不要有标点符号,如句号、逗号、冒号、分号等。
-
建议标题要尽量简短,这样方便引用,特别是当生成目录时。如果原拟的标题时是一个长句,可以从长句中提取标题,而将长句作为标题下的内容。
粗体和斜体
粗体由两个 * 包裹,斜体由 1 个 * 包裹。
使用规范
在粗体和斜体语法标记的内容,建议不要由空格。
推荐:
我是粗体,我是斜体.
段落与换行
Markdown 中的段落由一行或多行文本组成,不同的段落之间使用空行来标记。
语法说明如下。
- 如果行与行之间没有空行,则会被视为同一段落。
- 如果行与行之间有空行,则会被视为不同的段落。
- 空行是指行内什么都没有,或者只有空格和制表符。
- 如果想在段内换行,则需要在上一行的结尾插入两个以上的空格然后按回车键。
使用规范
为了便于阅读,应该限制每行字符的数量,通常每行不超过 80 个字符,可以在编辑器中进行设置。
- 关于换行,建议如下。
-
当超过 80 个字符后进行换行。
-
在一句话结束(。或!或?)之后换行。
-
当 URL 较长时换行。
通常 URL 较长会导致行字符数量超过限制,为了提高可读性,可以在 URL 之前加一个换行符。
例如:
大家好,我的博客是:
https://blog.csdn.net/Soy_Vivi或者通过引用链接来进行优化:
大家好,我的博客
列表
有序列表的语法如下。
数字序号 + 英文句号 + 空格 + 列表内容
无序列表的语法如下。
- + 空格 + 列表内容
嵌套列表的语法示例如下。
- 第一层列表
TAB + 第二层列表
TAB + TAB + 第三层列表
语法说明如下。
- 列表中可以嵌套列表。
- 有序列表和无序列表也可以互相嵌套。
使用规范
-
如果一个列表中所有的列表项都没有换行,建议使用 1 个空格。
推荐:- 说
- 学
-
如果列表项有换行,则建议给无序列表使用 3 个空格,给有序列表使用 2 个空格。
推荐:-
这个列表项
有换行 -
这个没有
-
这个有序列表项
有换行 -
这个没有
-
-
如果一个列表中的每个列表项都只有 1 行,建议列表项之间不要有空行。
推荐:- 抽烟
- 喝酒
- 烫头
-
如果列表项中有换行,建议在列表项之间空1行,这样会比较容易区分多行列表项的开始和结束。
推荐:-
抽很多的
烟 -
喝酒
-
-
建议在列表前 / 后都空 1 行。
推荐:
我的爱好:- 抽烟
- 喝酒
- 烫头
-
数字、字符、符号列表使用英文半角句号,句号后加空格。
推荐:- 我是好人
- 他是好人
分隔线
在Markdown中,分隔线由 3 个以上的 */-/_
来标记。
语法说明如下。
- 分隔线需使用至少 3 个以上的
*/-/_
来标记。 - 行内不能有其他的字符。
- 可以在标记符中间加上空格。
图片
插入图片的语法如下
![图片替代文字](图片地址)
语法说明如下
- 图片替代文字在图片无法正常显示时会比较有用,正常情况下可以为空。
- 图片地址可以时本地图片的路径也可以是网络图片的地址。
- 本地图片支持相对路径和绝对路径两种方式。
链接
-
文字链接
文字链接就是把链接地址直接写在文本中。语法是用方括号包裹链接文字,后面紧跟着括号包裹的链接地址,如下所示。
[链接文字](链接地址)
例如:
我的博客 -
引用链接
引用链接是把链接地址作为"变量"先在 Markdown 文件的页尾定义好,然后在正文中进行引用。其语法如下。
在正文中引用链接标记,可以理解未引用定义好的变量:
[链接文字][链接标记]
在底部定义链接标记,可以理解为定义一个地址变量:
[链接标记]:链接地址
例如:
我的博客
语法说明如下。
-
链接标记可以由字母、数字、空格和标点符号。
-
链接标记不区分大小写。
-
定义的链接内容可以放在当前文件的任意位置,建议放在页尾。
-
当链接地址为网络地址时要以 http/https 开头,否则会被识别为本地地址。
3.网址链接
在 Markdown 中,将网络地址或邮箱地址使用<>包裹起来会被自动转换为超链接。其语法如下。
<URL 或邮箱地址>
行内代码块
在 Markdown 中,行内代码引用使用 ` 包裹,如法如下。
代码块
在 Markdown 中,代码块以 Tab 键或 4 个空格开头,语法如下。
以 Tab 键开头:
def test_print();
或者以 4 个空格开头:
def test_print();
使用规范
-
除行内代码可以使用 ` 包裹以外,如果我们想转义或强调某些字符,也可以使用 ` 包裹。
推荐:
更多信息请查看`README.md` -
如果代码超过 1 行,请使用围栏代码块(扩展语法),并显示地声明语言,这样做便于阅读,并且可以显示语法高亮。
引用
语法
在 Markdown 中,引用由 > + 引用内容来标记,如下所示。
> 引用内容
语法说明如下。
- 多行引用也可以在每一行的开头都插入 > 。
- 在引用中可以嵌套引用。
- 在引用中可以使用其他的 Markdown 语法。
- 段落与换行的格式在引用中也是适用的。
使用规范
-
建议在引用的标记符号 > 之后添加一个空格。
推荐:
> 美是到处都有的。
-
建议每一行引用都使用符号 > 。
推荐:
> 美是到处都有的。
> 我们缺少的是发现美的眼睛。
-
不要在引用中添加空行。
推荐:
> 美是到处都有的。
>
> 我们缺少的是发现美的眼睛。
转义
当我们想在 Markdown 文件中插入一些标记符号,但又不想让这些符号被渲染时,可以使用 \ 进行转义。
语法如下:
\特殊符号
可以被转义的特殊符号如下。
\ 反斜线
‘ 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 记号
- 减号
. 英文句好
! 惊叹号