跳到主要内容

Markdown 基本语法

👁️‍🗨️阅读需 7 分钟
cq329

Markdown 是一种纯文本格式的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式,因为是纯文本,所以只要支持 Markdown 的地方都能获得一样的编辑效果,可以让作者摆脱排版的困扰专心写作,你只需要记一些简单语法就可以很快上手。

mdx

1. 标题

Markdown 支持六级标题,使用方法:一级标题前加一个#号,#号和标题之间加一个空格;二级标题前加两个#号;三级标题前加三个#号,以此类推。。。。。。

语法示例:

# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题

效果:

这是一级标题

这是二级标题

这是三级标题

这是四级标题

这是五级标题
这是六级标题

2. 字体

  • 粗体:要加粗的文字左右分别用两个 号包起来,号和文字之间没有空格
  • 斜体:要倾斜的文字左右分别用一个 号包起来,号和文字之间没有空格
  • 删除线:要加删除线的文字左右分别用两个~号包起来,~号和文字之间没有空格

语法示例:

**这是粗体**
*这是斜体*
~~这是带删除线的~~

效果:

这是粗体

这是斜体

这是带删除线的

3. 引用

在引用的文字前加 > 号即可。引用也可以嵌套,如加两个 >、 三个 >、n 个>... 语法示例:

>这是引用

>这是引用
>>这是嵌套引用

>这是引用
>>这是嵌套引用
>>>这还是嵌套引用

效果:

这是引用

这是引用

这是嵌套引用

这是引用

这是嵌套引用

这还是嵌套引用

4. 分割线

三个或者三个以上的 - 或者 * 都可以。 语法示例:

---
***
------------
************

效果:





5. 插入图片

开头一个感叹号 !,接着一个方括号,里面放上图片的替代文字,接着一个普通括号(),里面放上图片的网址,最后还可以用引号包住并加上选择性的 title 属性的文字。

语法示例:

![示例图片](https://t7.baidu.com/it/u=3303059925,1192891232&fm=193&f=GIF "插入图片演示")

效果: 示例图片

6. 超链接

超链接有两种用法:

  • 链接文本放在中括号内,链接地址放在后面的括号中,链接title可选。
  • 使用尖括号可以很方便地把URL或者email地址变成可点击的链接。

语法示例:

[这是一个超链接](https://baidu.com "百度一下")

<https://baidu.com>

效果:

这是一个超链接

https://baidu.com

7. 表格

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行

-文字左边加表示文字默认居左

-两边加表示文字居中-

右边加表示文字居右-

语法示例:

| 姓名 | 年龄 | 性别 | 籍贯 |
|:----|:----:|:----:|----:|
| 张三 | 23 | 男 | 广东 |
| 李四 | 26 | 男 | 辽宁 |
| 王五 | 21 | 女 | 山东 |

效果:

姓名年龄性别籍贯
张三23广东
李四26辽宁
王五21山东

8. 转义

Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符

语法示例:

**文本加粗** 
\*\* 正常显示星号 \*\*

效果:

文本加粗

** 正常显示星号 **

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号

9. 单行代码和代码块

  • 单行代码或段落上的一个函数或片段的代码可以用一个反引号对 ` 把它包起来
  • 代码块使用三个反引号对 ``` 包裹一段代码,并指定一种语言(也可以不指定)

语法示例:

单行代码:
`printf()` 函数
`这是一个单行代码演示`
代码块:
​```
class CaseData:
"""这是一个存放测试用例数据的类"""
pass
​```

效果:

printf() 函数

这是一个单行代码演示

class CaseData:
"""这是一个存放测试用例数据的类"""
pass

10. 脚注

脚注是对文本的补充说明。

语法示例:

[^要注明的文本]
创建脚注格式类似这样 [^RUNOOB]。

[^RUNOOB]: 这是一个脚注示例

效果:

创建脚注格式类似这样 RUNOOB

11. 支持的 HTML 元素

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。

用法

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

效果:

使用 Ctrl+Alt+Del 重启电脑

12. 复选框

列表符后一个空格一个中括号,后面是文字。未选中:中括号里面一个空格;选中:中括号里面一个 x

用法

- [ ] 这是未选中的
- [x] 这是选中的

效果:

  • 这是未选中的
  • 这是未选中的

  1. 这是一个脚注示例