markdown语法
markdown语法
以下内容来源于 https://www.runoob.com/markdown/md-tutorial.html
1 标题
标题有两种写法
1.1 使用=和-标记"一级标题"和"二级标题"
这种方法只能标记到二级标题, 无法标记三级标题或更低的标题.
(好像在这没成功)
这是一级标题
===========
这是二级标题
-----------
1.2 使用#标记标题
这种方法可以标记1~6级标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
2. 换行, 字体, 分隔线, 等
2.1 换行
段落和换行没有特殊格式, 直接换行即可.
一个或多个空行, 会展示为一个空行.
2.2 字体
文本:
*斜体文字*
_斜体文字_
**粗体文字**
__粗体文字__
***粗斜体文字***
___粗斜体文字___
效果:
斜体文字
斜体文字
粗体文字
粗体文字
粗斜体文字
粗斜体文字
2.3 分隔线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
文本:
***
* * *
****
---
___
_ _ _
效果:
2.4 删除线
文字两端加两个波浪线.
文本:
正常文字
~~删除线文字~~
效果:
正常文字
删除线文字
2.5 下划线
下划线可以通过 HTML 的 <u> 标签来实现:
文本:
<u>下划线文字</u>
效果:
下划线文字
2.6 脚注
脚注是对文本的补充说明, 格式如下:
(好像不怎么成功)
3. 列表
两种列表: 无序列表, 有序列表
3.1 无序列表
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:
文本:
* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
效果:
- 第一项
- 第二项
- 第三项
- 第一项
- 第二项
- 第三项
- 第一项
- 第二项
- 第三项
3.2 有序列表
有序列表使用数字并加上.号来表示,
前面的数字可以随意, markdown自动编号.
文本:
1. 第一项
1. 第二项
1. 第三项
效果:
- 第一项
- 第二项
- 第三项
3.3 列表嵌套
列表嵌套只需在子列表中的选项前面添加两个或四个空格即可:
文本:
1. 第一项
+ 1.1
+ 1.2
1. 第二项
- 2.1
- 2.2
效果:
- 第一项
- 1.1
- 1.2
- 第二项
- 2.1
- 2.2
4. 区块
Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号
4.1 区块基本使用
文本:
> 区块引用
> 第二行区块
> 第三行区块
>
效果:
区块引用
第二行区块
第三行区块
4.2 区块嵌套
区块还可以嵌套, 多个>表示多层嵌套, >之间可以有空格.
文本:
> 第一层区块
> > 第二层区块
>>> 第三层区块
效果:
第一层区块
第二层区块
第三层区块
4.3 区块中使用列表
文本:
> 区块中使用列表
> 1. 第一项
> 2. 第二项
>
> + 第一项
> + 第二项
> + 第三项
效果:
区块中使用列表
- 第一项
- 第二项
- 第一项
- 第二项
- 第三项
4.4 列表中使用区块
文本:
* 第一项
> 区块内容
> 区块内容
* 第二项
> 区块内容
> 区块内容
效果:
- 第一项
区块内容
区块内容 - 第二项
区块内容
区块内容
5. 代码
5.1 段落文本中间的函数或代码片段
使用反引号(`)把它包起来
文本:
这是一个`printf()`函数
效果:
这是一个printf()
函数
5.2 代码区块
使用```把一段代码包裹起来,
还可以指定一种语言(也可以不指定).
文本:
\`\`\`
这是代码块
这是代码块
\`\`\`
效果:
这是代码块
这是代码块
或者代码块行首使用4个空格或一个Tab:
文本:
这是代码块
这是代码块
这是代码块
效果:
这是代码块
这是代码块
这是代码块
6. 链接
6.1 直接写链接地址
在渲染后, 以下会显示为这个网址, 点击后进入某网站.
文本:
<https://www.baidu.com>
6.2 给链接取个名字
在渲染后, 以下会显示为"百毒", 点击后进入某网站.
文本:
[百毒](https://www.baidu.com)
效果:
百毒
6.3 通过变量设置链接
渲染后, 会显示"古狗"和"百毒"两个文本, 点击后进入对应网站.
文本:
[古狗][1]
[百毒][abcd]
[1]: http://www.google.com/
[abcd]: https://www.baidu.com/
7. 图片
图片的标记如下:
文本:
![图片替代文字](图片地址)
![图片替代文字](图片地址 "可选标题")
效果:
"图片替代文字"是指图片地址不可用时, 在本来图片的位置显示的内容.
"可选标题"是指鼠标移动到图片上时, 出现的提示框.
图片地址也可以像网址一样使用变量.
如果需要指定图片高度或宽度, 只能使用标签.
<img decoding="async" src="xx/xx/xx.png" width="50%">
8. 表格
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
文本:
表头|表头
----|----
单元格|单元格
单元格|单元格
单元格|单元格
效果:
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
单元格 | 单元格 |
可以设置表格对齐方式
-:
该列标题和内容右对齐:-
该列标题和内容左对齐:-:
该列标题和内容居中对齐
文本:
|左对齐|居中对齐|右对齐|
|:----|:--:|---:|
|单元格 |单元格 |单元格 |
|单元格1 |单元格1 |单元格1 |
|单元格12|单元格12|单元格12|
效果:
左对齐 | 居中对齐 | 右对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格1 | 单元格1 | 单元格1 |
单元格12 | 单元格12 | 单元格12 |
9. 高级技巧
9.1 html元素
mardown中可以直接使用HTML标签
9.2 转义
在markdown中有特殊意义的符号, 如果要显示它们, 需要使用转义符
文本:
**文本加粗**
\*\*正常显示星号\*\*
效果
文本加粗
**正常显示星号**
9.3 公式
Markdown Preview Enhanced 使用 KaTeX 或者 MathJax 来渲染数学表达式。
KaTeX 拥有比 MathJax 更快的性能,但是它却少了很多 MathJax 拥有的特性。你可以查看 KaTeX supported functions/symbols 来了解 KaTeX 支持那些符号和函数。
文本:
$...$ 或者 \(...\) 中的数学表达式将会在行内显示。
$$...$$ 或者 \[...\] 或者 ```math 中的数学表达式将会在块内显示。
效果:
\(...\) 或者 (...) 中的数学表达式将会在行内显示。