Skip to content

导读 - MarkDown文件语法

1.前言

Markdown 是一种轻量级标记语言,旨在以易读易写的方式编写文档。它是由约翰·格鲁伯(John Gruber)和亚伦·斯沃茨(Aaron Swartz)于2004年创建的。Markdown 的设计初衷是使写作更加简单,让人们可以专注于内容而不是格式。它在编写简单文档、笔记、博客文章、技术文档等方面都具有很高的适用性。

在 Markdown 中,你可以使用纯文本编辑器编写文档,并通过简单的符号标记来表示文档的结构和格式。Markdown 文档可以很容易地转换为 HTML、PDF、Word 等多种格式,便于在不同平台和环境中分享和阅读。

同时,Markdown 语法简单直观,易于上手。它包含了一些基本的标记,如分级标题、列表、链接、图片等,同时也支持一些扩展语法,如表格、数学公式等,使得用户可以根据需要灵活地扩展和定制文档。

2.基础语法

分级标题

使用不同数量的井号(#)表示不同级别的标题,例如:

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

这些标题依次显示为不同级别的标题,分别对应 HTML 中的 h1 到 h6 标签。

文字样式

Markdown 支持多种文字样式,包括斜体、粗体、粗斜体。

  • 斜体文本:使用一个星号(*)或下划线(_)包裹文字。
  • 粗体文本:使用两个星号(**)或下划线包(__)裹文字。
  • 粗斜体文本:使用三个星号(***)或下划线(___)包裹文字。
*斜体文本*  
**粗体文本**  
***粗斜体文本***

列表

支持有序列表和无序列表两种列表方式

  • 有序列表使用数字和点号表示
1. 有序列表项一  
2. 有序列表项二   
3. 有序列表项三
  • 无序列表使用星号(*)、加号(+)或减号(-)表示
- 无序列表项一
- 无序列表项二
- 无序列表项三

链接

支持行内式和参考式两种链接格式。

  • 行内式链接:
[链接文字](链接地址 "可选标题")
[百度一下](https://www.baidu.com/)
  • 参考式链接:
[链接文字][链接标识符]
[Baidu][1] [Baidu][2]

[链接标识符]: 链接地址 "可选标题"
[1]: https://www.baidu.com "百度一下"

代码区块

插入代码区块使用三个反引号(```),并可以指定语言类型以实现代码高亮显示。

python
def hello():
    print("Hello, Markdown!")
hello()

代码嵌入

可以在文本中直接嵌入代码,使用两个单个反引号()包裹代码。 print("Hello, Markdown!")`

图片

插入图片与插入链接的语法类似,只需在链接语法前加上感叹号(!)。

![图片描述](图片链接 "可选标题")

块引用

使用大于号(>)表示块引用。

> 块引用文字。

块引用可以嵌套,一个>符号是最外层,两个符号是第一层嵌套,以此类推:

> 最外层
>> 第一层嵌套
>>> 第二层嵌套

水平线

可以使用三个或更多的星号、减号或下划线来创建水平线。

***
---
___

生成目录

在想要展示目录的地方加上 [TOC],就在该处生成显示全文内容的目录结构。

[TOC]

支持的 HTML 标签

Markdown 也支持使用部分 HTML 标签来实现一些特殊效果,例如添加字体颜色、大小等。

<font color="red">红色</font>
<font size="7">大号文字</font>

3. 扩展语法

扩展语法提供了一些额外的功能和样式,使得文档更加丰富和易读

删除线

双波浪线 ~~ 包裹需要删除的文字

~~删除线~~:使用两个波浪线(~~)包裹文字。

下划线:使用 HTML 的 <u> 标签包裹需要下划线的文字

<u>下划线</u>:使用 HTML 的 `<u>` 标签。

上标与下标

上标和下标可以通过 ^ 和 ~ 包裹需要标记的内容来实现

CO~2~

高亮

高亮可以使用双等号 == 包裹需要高亮的文字,比如:

==高亮的文字==

锚点

锚点可以用于标记文档中的特定位置,方便跳转到指定位置。 (无法演示,在文章开头设置要跳转的位置顶部)

[跳转到顶部](#顶部)

表格

使用竖线(|)和短横线(-)来标识表格的列和行。

| 表头1 | 表头2 | 表头3 |
| ----- | ----- | ----- |
| 单元格1 | 单元格2 | 单元格3 |

|  |  |
| ----- | ----- |
|  |  |

还可以设置表格的对齐方式,通过在表头下的分隔线中使用冒号 : 来调整对齐方式。比如:

| 左对齐 | 居中对齐 | 右对齐 |
| :--- | :---: | ---: |
| 内容1 | 内容2 | 内容3 |
| 内容4 | 内容5 | 内容6 |

待办事项

可以在文档中添加待办事项列表

- [ ] 未完成任务
- [x] 已完成任务

数学公式

支持使用 LaTeX 语法插入数学公式。使用单个美元符号包裹行内公式,双美元符号包裹块状公式。

$E=mc^2$
$$
E=mc^2
$$
$\sum_{i=0}^n$

注脚

可以在文本中添加注脚。

[^注脚名称]: 注脚内容
这是正文[^注脚名称]

最后更新:

创作不易请尊重他人劳动成果,未经授权禁止转载!
Released under the MIT License.