跳到主要内容

Markdown 基础入门

Markdown 是一种轻量级标记语言,用纯文本加少量符号就能写出结构清晰的文档。 它被广泛用于 README、博客、笔记、文档站点(包括本站)等场景,几分钟即可上手。


1. 认识 Markdown

1.1 什么是 Markdown

  • 用简单的符号(#*>| 等)表示标题、列表、引用、表格等结构
  • 文件后缀通常为 .md
  • 纯文本编写,易于版本管理(配合 Git
  • 可渲染为 HTML 网页、PDF 等

1.2 常用编辑器

编辑器说明
VS Code安装 Markdown 插件,可实时预览
Typora所见即所得,适合写作
Obsidian本地知识库,双链笔记
各类在线编辑器如 GitHub 自带预览

核心心法:语法很少,够用就好。遇到不记得的,查本文即可。


2. 标题

# 表示标题,# 数量表示层级(1~6 级),# 后要有一个空格

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

一般一篇文章只用一个一级标题(作标题),正文用二、三级。


3. 段落与换行

  • 段落:空一行分隔两段。
  • 换行:行尾加两个空格再回车,或直接空一行。
这是第一段。

这是第二段。

这一行末尾有两个空格
所以这里是换行。

4. 强调

*斜体*_斜体_
**粗体**__粗体__
***粗斜体***
~~删除线~~
`行内代码`

效果:斜体粗体粗斜体删除线行内代码


5. 列表

5.1 无序列表

-*+

- 苹果
- 香蕉
- 橙子

5.2 有序列表

数字.

1. 第一步
2. 第二步
3. 第三步

5.3 嵌套列表

子项缩进两个或四个空格

- 前端
- HTML
- CSS
- 后端
- Python
- Go

5.4 任务列表

- [x] 已完成事项
- [ ] 待办事项

6. 引用

>,可嵌套:

> 这是一段引用。
>
> > 这是嵌套引用。

> 引用中也可以放**其他语法**

7. 代码

7.1 行内代码

用反引号包裹:

请执行 `git status` 命令。

7.2 代码块

用三个反引号包裹,并标注语言以获得高亮:

```python
def hello():
print("Hello")
```

标注语言(如 pythonjsbash)后,渲染时会有语法高亮。


8. 链接与图片

8.1 链接

[链接文字](https://example.com)
[相对路径链接](./other.md)
[带标题的链接](https://example.com "鼠标悬停显示")

8.2 图片

语法比链接多一个 !

![图片说明](图片地址.png)
![网络图片](https://example.com/a.png)

8.3 引用式链接

把地址统一放在文末,正文只写标记:

这是一个 [GitHub][1] 链接。

[1]: https://github.com

9. 分隔线

单独一行写三个及以上的 -*_

---

10. 表格

| 分列,第二行用 --- 定义表头分隔,: 控制对齐:

| 左对齐 | 居中 | 右对齐 |
|:-------|:----:|-------:|
| A | B | C |
| 1 | 2 | 3 |

效果:

左对齐居中右对齐
ABC
123

11. 转义特殊字符

想原样显示 *#_ 等符号时,在前面加反斜杠 \

\* 这不是斜体 \*
\# 这不是标题

12. 综合示例

# 项目说明

这是一个 **演示项目**,支持以下功能:

- [x] 功能一
- [ ] 功能二

## 快速开始

```bash
git clone https://example.com/demo.git
cd demo
npm install
```

> 详细用法见 [官方文档](https://example.com/docs)

| 参数 | 说明 |
|---|---|
| `-h` | 显示帮助 |
| `-v` | 显示版本 |

13. 编写建议

  1. 标题层级不要跳级# 后接 ### 容易混乱)。
  2. 列表、代码块前后留空行,兼容性更好。
  3. 中英文之间加空格,阅读更舒适。
  4. 图片、链接使用有意义的说明文字,方便无障碍阅读。
  5. 一个文件聚焦一个主题,善用目录(进阶篇讲解)。

继续阅读 Markdown 进阶,学习目录、脚注、HTML、数学公式与文档实践。