前言
Markdown
是一种轻量级的标记语言,允许人们使用易读易写的纯文本格式编写文档,然后转换成结构化的HTML(超文本标记语言)文档。Markdown
的设计目的是使文本内容的排版变得简单,无需关注复杂的HTML标签。用户在编辑时只需使用一些特定的符号和语法,就可以轻松地为文本添加格式,如粗体、斜体、标题、列表、链接和图片等元素。Markdown
文档便于人们阅读和编写,同时也方便转换为多种格式,广泛应用于GitHub、技术文档、博客写作、笔记软件等领域。
1. 基本使用语法
1.1 标题语法
创建标题要在单词或短语前面添加井号 (#
) 。#
的数量代表了标题的级别。例如,添加三个#
表示创建一个三级标题 (<h3>
)。
Markdown语法 | HTML表示 | 预览效果 |
---|---|---|
# 一级标题 | <h1>一级标题</h1> | 一级标题 |
## 二级标题 | <h2>二级标题</h2> | 二级标题 |
### 三级标题 | <h3>三级标题</h3> | 三级标题 |
#### 四级标题 | <h4>四级标题</h4> | 四级标题 |
##### 五级标题 | <h5>五级标题</h5> | 五级标题 |
###### 六级标题 | <h6>六级标题</h6> | 五级标题 |
不同的 Markdown 语法编辑器里面对 # 和标题之间的空格方式并不一致。为了兼容考虑,请用一个空格在 # 和标题之间进行分隔。即按照这种语法设置
# 一级标题
1.2 换行
进行换行操作时,建议使用HTML语法的<br/>
标签。虽然其他一些方法也可以用,但是还是这个好用。
- Markdown语法
创建段落要请使用空白行将一行或多行文本进行分隔<br/>创建段落要请使用空白行将一行或多行文本进行分隔。
- HTML表示
创建段落要请使用空白行将一行或多行文本进行分隔<br/>创建段落要请使用空白行将一行或多行文本进行分隔。
- 预览效果
创建段落要请使用空白行将一行或多行文本进行分隔。
创建段落要请使用空白行将一行或多行文本进行分隔。
1.3 引用
Markdown中的引用类似于代码块一样单独划出了一块编辑空间,与正文形成明显的划分。通过符号 >
来实现。
- Markdown语法
>引用类似于代码块一样单独划出了一块编辑空间
# 嵌套引用
>一层嵌套
>>二层嵌套
>>>三层嵌套引用
- 预览效果
引用类似于代码块一样单独划出了一块编辑空间
- 预览嵌套效果
一层嵌套
二层嵌套
三层嵌套引用
1.4 强调和线条
- 字体强调
将文本设置为粗体或斜体来强调其重要性,使用的符号星号(*
)和下划线(_
)都可以。
Markdown语法 | HTML表示 | 预览效果 |
---|---|---|
*斜体* | <em>斜体</em> | 斜体 |
_斜体_ | <em>斜体</em> | 斜体 |
**加粗** | <strong>加粗</strong> | 加粗 |
__加粗__ | <strong>加粗</strong> | 加粗 |
如果想要实现斜体加粗的效果的话,可以将两种方式进行组合即可。
- 分割线
创建分隔线可以单独一行上使用三个或多个星号 (***
)、破折号 (---
) 或下划线 (___
) ,并且不能包含其他内容来实现。三个分隔线的渲染效果是一样的。
***
---
___
注意:写分割线前,要空一行之后写,否则会导致前一行字体放大。
- 删除线
删除线将文本内容进行割裂,表示删除该部分文本。使用方法是在要删除的文字前后添加两个~
。
~~删除线将文本内容进行割裂,表示删除该部分文本。~~
删除线将文本内容进行割裂,表示删除该部分文本。
- 下划线
下划线可以直接使用HTML的语法,在需要添加的文字首尾处添加<u>文本</u>
。
<u>下划线可以直接使用HTML的语法.</u>
下划线可以直接使用HTML的语法.
1.5 网址链接
插入网页链接是在方块括号后面接括号并插入网址链接即可,如果你还想要加上链接的 alt 提示文字,只要在网址后面,用双引号把 alt 文字包起来即可。
- 语法
[链接名称](链接地址 "提示文字")
[百度](https://www.baidu.com/ "百度一下")
- HTML表示
<a href="链接地址" title="提示文字" > 链接名称 </a>
<a href="https://www.baidu.com/" title="百度一下" > 百度 </a>
- 预览效果
百度
1.6 图片
插入图片的方法与插入网页的方式类似。使用感叹号 (!
),然后在方括号增加替代文本,图片链接放在圆括号里,括号里的链接后可以增加一个可选的图片标题文本。
- 语法
![图片提示文字](图片链接 "图片title")
![马达加斯加-菜鸟](https://i-blog.csdnimg.cn/direct/824e2e0e13de470b8af31f5f0380ff2e.jpeg "企鹅菜鸟")
- HTML表示
<img src="图片链接" alt="图片提示文字" title="图片title">
<img src="https://i-blog.csdnimg.cn/direct/824e2e0e13de470b8af31f5f0380ff2e.jpeg" alt="马达加斯加-菜鸟" title="企鹅菜鸟">
- 预览效果
有时需要调整图片的大小,但是Markdown本身不直接支持改变图片尺寸,但可以通过HTML的
<img>
标签来实现。常用的有设置图片大小和居中显示。<!--设置图片大小--> <img src="https://example.com/path/to/image.jpg" width="500" height="300"> <!--width和height属性用于指定图片的显示宽度和高度--> <!--如果希望图片能根据页面宽度自适应调整大小,可以在<img>标签中使用width="100%",并保持高度自动调整--> <img src="https://example.com/path/to/image.jpg" width="100%"> <!--居中显示--> <div align=center> <img src="https://example.com/path/to/image.jpg" width="100%"> </div>
1.7 列表
1.7.1 无序列表
无序列表:在每个列表项前面添加破折号 (-
)、星号 (*
) 或加号 (+
) 。缩进一个或多个列表项可创建嵌套列表。
- 语法
+ 无序列表 1
+ 无序列表 2
+ 无序列表 2.1
+ 无序列表 2.2
- 效果展示
- 无序列表 1
- 111
- 无序列表 2
- 无序列表 2.1
- 无序列表 2.2
- 补充
不同的Markdown编辑器在如何处理同一列表中的不同分隔符方面存在分歧。为了兼容,不要在同一个列表中混合使用分隔符,建议选择一个并坚持使用。
1.7.2 有序列表
有序列表:在每个列表项前添加数字并紧跟一个英文句点。缩进一个或多个列表项可创建嵌套列表。
- 语法
1. 有序列表 1
2. 有序列表 2
1. 有序列表 2.1
2. 有序列表 2.2
3. 有序列表 3
4. 有序列表 4
- 效果展示
- 有序列表 1
- 有序列表 2
- 有序列表 2.1
- 有序列表 2.2
- 有序列表 3
- 有序列表 4
- 补充
有序列表数字不必按数学顺序排列,显示内容会根据层级自动修正成顺序,但是列表应当以数字 1 起始。
1. 有序列表 1 2. 有序列表 2 1. 有序列表 1 2. 有序列表 2
- 有序列表 1
- 有序列表 2
- 有序列表 1
- 有序列表 2
1.7.3 任务列表
任务列表就是哪些显示任务完成情况的列表,勾选选项是否完成的那种。
- 语法
- [x] 任务列表1
- [x] 任务列表2
- [ ] 任务列表3
- [ ] 任务列表4
- 效果展示
- 任务列表1
- 任务列表2
- 任务列表3
- 任务列表4
- 补充
任务列表同样可以和有序列表、无序列表一起嵌套使用。
1.8 代码
1.8.1 行内代码
行内代码的格式很简单,只需要使用两个反引号(`)将代码内容包裹起来即可.
- 语法
`行内代码`的格式很简单。
- 效果展示
行内代码
的格式很简单。
1.8.2 代码块
代码块可以表示一段较长的代码或者想要格式化一大块文本为代码样式,可以使用三个反引号(```)包围代码,并可(可选)指定编程语言以获得合适的高亮。
- 语法
# ```python
# def hello_world():
# print("Hello, World!")
# ```
# 实际语法是去掉井号#之后的样子。
- 效果展示
def hello_world():
print("Hello, World!")
1.9 表格
添加表格的话,需要使用三个或多个连字符(---
)分割标题行和内容行,并使用管道(|
)分隔每列,可以选择在表的任一端添加管道。
- 语法
| 列名1 | 列名2 |
| --- | --- |
| 数据1 | 数据2 |
| 数据3 | 数据4 |
- 效果
列名1 | 列名2 |
---|---|
数据1 | 数据2 |
数据3 | 数据4 |
- 补充
可以通过在标题行中的连字符的左侧,右侧或两侧添加冒号(
:
),将列中的文本对齐到左侧,右侧或居中。| 列名1 | 列名2 | 列名2 | | :--- | :---: | ---: | | 数据1 | 数据2 | 数据3 | | 数据4 | 数据5 | 数据6 |
列名1 列名2 列名2 数据1 数据2 数据3 数据4 数据5 数据6
2. 扩展语法
2.1 转义字符
要显示原本用于格式化 Markdown 文档的字符,要在字符前面添加反斜杠字符 \
。
2.2 公式
Markdown支持书写公式,$$
表示整行公式;^
表示右上角幂值;_
表示右下角底数。
- 举例
质能守恒公式: E = m c 2 E=mc^2 E=mc2
对数换底公式: l o g a ( N ) = l o g b ( N ) / l o g b ( a ) log_a(N)=log_b(N)/log_b(a) loga(N)=logb(N)/logb(a)
2.3 脚注
脚注可以用来添加注释和参考,而不会使文档正文混乱。当创建脚注时,带有脚注的上标数字会出现在添加脚注参考的位置。可以单击链接以跳至页面底部的脚注内容。
创建脚注参考,要在方括号([^1]
)内添加插入符号和标识符。标识符可以是数字或单词,但不能包含空格或制表符。标识符仅将脚注参考与脚注本身相关联。在输出中,脚注按顺序编号。
- 语法
Markdown[^1]是一种轻量级的标记语言,允许人们使用易读易写的纯文本格式编写文档,然后转换成结构化的HTML[^html]文档。
[^1]:Markdown[^1]是一种轻量级的标记语言。
[^html]:一种超文本标记语言。
- 效果展示
Markdown1是一种轻量级的标记语言,允许人们使用易读易写的纯文本格式编写文档,然后转换成结构化的HTML2文档。