关于本笔记
- 书写起始时间: 2023-7-21
- 最新更新时间: 2023-7-22
MarkDown 学习笔记
第一部分 概述
一 介绍
- Markdown 由 John Gruber 于 2004 年创建。
- 其文件扩展名为 .md 或 .markdown ,比如将编辑好的 .txt 文件的后缀名改成 .md 即可得到一个 MarkDown 文件。
- 是一种轻量级的标记语言,可用于在纯文本文档中添加格式化元素。并且一般可与 HTML 混编(即可以把大多数 Html 元素写在 MarkDown 中)。
二 语法简要罗列
1 基本元素
注: 所有 Markdown 应用程序都支持这些元素。
-
标题(Heading)
# H1 ## H2 ### H3
-
粗体(Bold)
**bold text**
-
斜体(Italic)
*italicized text*
-
引用块(Blockquote)
> blockquote
-
有序列表(Ordered List)
1. First item 2. Second item 3. Third item
-
无序列表(Unordered List)
- First item - Second item - Third item
-
代码(Code)
`code`
-
分隔线(Horizontal Rule)
---
-
链接(Link)
[title](https://www.example.com)
-
图片(Image)
![alt text](image.jpg)
扩展语法
注: 并非所有 Markdown 应用程序都支持这些元素。
-
表格(Table)
| 姓名 | 年龄 | |-------------|-------------| | A | 25 | | B | 21 |
-
代码块(Fenced Code Block)
``` 第一行 第二行 ... 第 n 行 ```
-
脚注(Footnote)
Here's a sentence with a footnote. [^1] [^1]: This is the footnote.
-
标题编号(Heading ID)
### My Great Heading {#custom-id}
-
定义列表(Definition List)
term : definition
-
删除线(Strikethrough)
~~添加删除线的文本~~
-
颜色标记
==被标记文本==
-
上下标
H~2~O
2^10^
-
任务列表(Task List)
- [x] Write the press release - [ ] Update the website - [ ] Contact the media
三 相关地址请参考
Markdown 官方教程: https://markdown.com.cn/
Markdown 官方编辑器: https://markdown.com.cn/editor/
Markdown 教程 | 菜鸟教程: https://www.runoob.com/markdown/md-tutorial.html
Markdown 创建者编写的原始指南: https://daringfireball.net/projects/markdown/
第二部分 基本语法
一 标题语法
1 方法1
- 可以在单词或短语前面添加井号 (#) 来表示标题,# 的数量代表了标题的级别(可以是 1-6 );
- 并且注意为了语法规范起见,尽量在文字和 # 号之间加一个空格。
MarkDown语句 | 渲染效果 |
---|---|
# 一级标题 | 一级标题 |
## 二级标题 | 二级标题 |
### 三级标题 | 三级标题 |
#### 四级标题 | 四级标题 |
##### 五级标题 | 五级标题 |
###### 六级标题 | 六级标题 |
2 方法2
- 可以在文本下方添加任意数量的
==
号来标识一级标题,或者--
号来标识二级标题。
MarkDown语句 | 渲染效果 |
---|---|
一级标题 ============ | 一级标题 |
二级标题 ------------ | 二级标题 |
二 分段语法
- 在上下文之间使用
空白行
,便可对文本进行分隔; - 不过注意多行连续的空白行,在预览时会被转换为一行。
三 换行语法
- 在一行的末尾添加
两个或多个空格
,然后按回车键; - 或者在文本中间位置添加
<br>
,即可将左右文本分成两行。
四 强调语法
1 斜体(Italic)
- 在 单词/短语 的前后各添加一个星号
*
或一个下划线_
,对于下划线、其两侧需要加空格; - 如需加粗一个单词或短语的中间部分用以表示强调的话,请在要加粗部分的两侧各添加一个星号
*
。
MarkDown语句 | 渲染效果 |
---|---|
您好!*BY*! | 您好!BY! |
*您*好!BY! | 您好!BY! |
2 粗体(Bold)
- 在 单词/短语 的前后各添加两个星号
**
或两个下划线__
,对于下划线、其两侧需要加空格; - 如需加粗一个单词或短语的中间部分用以表示强调的话,请在要加粗部分的两侧各添加两个星号
**
。
MarkDown语句 | 渲染效果 |
---|---|
您好!**BY**! | 您好!BY! |
**您**好!BY! | 您好!BY! |
3 粗体(Bold)和斜体(Italic)
- 在 单词/短语 的前后各添加三个星号
***
或三个下划线___
,对于下划线、其两侧需要加空格; - 如需加粗一个单词或短语的中间部分用以表示强调的话,请在要加粗部分的两侧各添加三个星号
***
。
MarkDown语句 | 渲染效果 |
---|---|
您好!***BY***! | 您好!BY! |
***您*** 好!BY! | 您 好!BY! |
五 引用语法
- 通过在段首添加
>
符号,即可创建块引用; - 可以在连续多段的开头位置都添加
>
符号,以形成多个段落的块引用。 - 块引用可以进行多层嵌套,并且其中可以包含其他部分 Markdown 格式的元素。
以下将嵌套一个表格
Title1 Title2 Cell1 Cell2
六 列表语法
1 有序列表
- 在段首添加一个带
.
的序号(注意“.”后面至少需要紧跟一个空格),即可创建一个有序列表; - 序号可以是任意大于等于 0 的数字;
- 在原文本内进行缩进或添加即可以嵌套列表或者其他部分元素;
- 列表排版后的起始序号和原文本内当前层次的起始序号一致;
- 对于列表的最外层,不论原文本内后续同层的序号为几、渲染时都会按照最外层的起始序号来进行加一编号;但是对于内层而言,渲染时会按照原文本内的原序号来进行编号。
MarkDown语句 | 渲染效果 |
---|---|
0. A 7. B 0. C 3. D 2. E | 0. A 1. B 0. C 3. D 3. E |
2 无序列表
- 在段首添加一个
-
/*
/+
(注意这些符号后面也至少需要紧跟一个空格),即可创建一个无序列表; - 在原文本内进行缩进或添加即可以嵌套列表或者其他部分元素。
七 代码语法
- 对于 单词/短语/单行 ,请将其包裹在反引号
`
中; - 对于多行,请对多行整体进行缩进(至少四个空格或一个制表符);
- 若需要转义反引号,则需要将 单个反引号或其对应的单词或短语 包裹在双反引号
``
中,并且注意起始和结束位置需要加空格。
八 分隔线语法
- 要创建分隔线,请在单独一行上使用
***
、---
或___
,并且不能包含其他内容; - 可以通过连续创建多行
***
、---
或___
,来创建多行分隔线。
九 链接语法
1 方法1
- 语法:
[显示文本](对应的超链接地址 "鼠标悬停在链接上时会出现的文字")
- 说明: 圆括号内的两个参数都是可选的,这两个需要用空格分隔,并且第二个参数必须被引起来。
2 方法2
- 语法:
<URL或email地址>
- 说明: 这种方式下就不存在显示文本和所谓的悬停内容了。
3 方法3
- 语法:
[显示文本][标签]
[标签]:对应的超链接地址
- 说明: 语法中的第二部分可以放到 Markdown 文档中的任何位置。
十 图片语法
- 语法:
![图片底部的显示文本](对应的超链接地址 "鼠标悬停在链接上时会出现的文字")
- 说明: 可以为图片添加对应的链接,只需要将以上语法整体作为 链接语法 的
显示文本
即可,但是注意此时不能再添加链接语法内的"鼠标悬停在链接上时会出现的文字"
。
十一 转义字符
- 可以在以下字符前加
\
,来渲染这个字符本身
\ ` * _ { } [ ] ( ) # + - . ! |
十二 内嵌 HTML 标签
- 对于 Markdown 涵盖范围之外的 HTML 标签,都可以直接在 Markdown 文件内使用,但是注意在 Markdown 文件中、在 HTML 块级标签内不能使用 Markdown 语法。
- 例1: 可以利用 Html 中的
<u>
标签来为文本添加下划线,即
带下划线文本- 例2: 可以利用 Html 中的 字符实体 来代替一些符号,即
比如 实体编号°
或 实体名称°
都代表 ° 。
第三部分 扩展语法
一 表格语法
- 至少有两行才能形成表格,第一行是表头、第二行指定水平对其方式(并且第二行内必须添加 一个或多个 连字符)、后续行用来添加表格主体内容,即
| Syntax | Description | Test Text |
|:----------------|:-------------:|---------------:|
|:-代表这一列左对齐|:-:代表这一列居中|:-代表这一列右对齐|
注意表格内不能添加 标题、块引用、列表、表格 等等;可以添加 链接、代码和图像 等等。
二 L a T e X LaTeX LaTeX 语法
- 单行的话,两边用
$
括住即可; - 多行的话,上下用
$$
包围即可。