技术文档

Markdown语法指南

Markdown是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成有效的HTML文档。本文将详细介绍Markdown的各种语法。

标题

Markdown支持6级标题：

一级标题 # 一级标题

二级标题 ## 二级标题

三级标题 ### 三级标题

四级标题 #### 四级标题

五级标题 ##### 五级标题
六级标题 ###### 六级标题

段落

Markdown中的段落由一个或多个空行分隔。

文本样式

粗体和斜体

  • 粗体文本：**粗体** 或 __粗体__
  • 斜体文本：*斜体* 或 _斜体_
  • 粗斜体：***粗斜体*** 或 ___粗斜体___

删除线

删除线文本：~~删除线文本~~

高亮

==高亮文本==：==高亮文本==

列表

无序列表

1
2
3
4
5
- 项目1
- 项目2
  - 子项目1
  - 子项目2
- 项目3
  • 项目1
  • 项目2
    • 子项目1
    • 子项目2
  • 项目3

有序列表

1
2
3
4
5
1. 第一项
2. 第二项
   1. 子项1
   2. 子项2
3. 第三项
  1. 第一项
  2. 第二项
    1. 子项1
    2. 子项2
  3. 第三项

任务列表

1
2
3
- [x] 已完成任务
- [ ] 未完成任务
- [ ] 另一个任务
  • 已完成任务
  • 未完成任务
  • 另一个任务

链接和图片

链接

  • 行内链接：Google [Google](https://www.google.com)
  • 引用链接：百度 [百度][1] 文末注明[1]: https://www.baidu.com
  • 自动链接：https://www.github.com <https://www.github.com>

图片

![行内图片](\images\markdown.jpg "行内图片") HEXO框架下显示可能会有问题

  • 行内图片：行内图片

![引用图片][2] 文末注明[2]: \images\markdown.jpg HEXO框架下显示可能会有问题

  • 引用图片：引用图片

<img src="\images\Markdown语法\markdown.jpg" alt="行内图片" style="zoom:25%;" />

  • 自动图片：行内图片

代码

行内代码

使用三个反引号(英文输入法下的`)print("Hello World")

代码块

1
2
3
4
python
def hello_world():
    print("Hello, World!")
    return True
1
2
3
4
javascript
function greet(name) {
    console.log(`Hello, ${name}!`);
}

表格

1
2
3
4
5
6
7
8
9
10
| 姓名 | 年龄 | 城市 |
|------|------|------|
| 张三 | 25   | 北京 |
| 李四 | 30   | 上海 |
| 王五 | 28   | 广州 |

对齐方式：
| 左对齐 | 居中对齐 | 右对齐 |
|:-------|:--------:|-------:|
| 文本   | 文本     | 文本   |
姓名 年龄 城市
张三 25 北京
李四 30 上海
王五 28 广州

对齐方式：

左对齐 居中对齐 右对齐
文本 文本 文本

引用块

使用>开头

1
2
3
4
5
> 这是一个引用块
> 
> 可以包含多行内容
> 
> > 嵌套引用也是支持的

这是一个引用块

可以包含多行内容

嵌套引用也是支持的

水平分割线

使用三个或更多的连字符、星号或下划线：

1
2
3
---
***
___

脚注

这是一个带有脚注的句子^1。

数学公式（部分Markdown处理器支持）

行内公式：$E = mc^2$

块级公式：
$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$

转义字符

如果需要显示Markdown的特殊字符，使用反斜杠转义：

* 这不是斜体 *
# 这不是标题
[ ] 这不是链接

高级功能

目录（TOC）

有些Markdown处理器支持自动生成目录：

[TOC]

注释

定义列表

术语1
定义1
术语2
定义2

最佳实践

  1. 保持一致性：在整个文档中使用相同的格式
  2. 适当使用空白行：提高可读性
  3. 使用有意义的标题：便于导航
  4. 定期预览：确保格式正确