Markdown 快速入门
Markdown 是一种轻量级标记语言,用简单的符号就能控制文本格式。本文覆盖开发者日常最常用的语法。
什么是 Markdown
Markdown 是一种纯文本标记语言,用少量符号标注格式,最终渲染成结构化的富文本。它的核心优势是可读性强——即使不渲染,源文件本身也易于阅读。
常见使用场景:
- GitHub README、Issue、PR 描述
- 博客文章、技术文档
- 代码注释、 committing message
- 笔记应用(Obsidian、Notion 等)
标题
用 # 数量表示标题层级:
text
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
实际写作中通常从二级标题开始,一级标题留给文档标题或页面自动生成。
文本样式
| 语法 | 效果 |
|---|---|
**粗体** | 粗体 |
*斜体* | 斜体 |
~~删除线~~ | |
`行内代码` | 行内代码 |
[链接文字](URL) | 可点击链接 |
列表
无序列表(用 - 或 *):
text
- 第一项
- 第二项
- 嵌套项
- 嵌套项
- 第三项
有序列表(用数字 + .):
text
1. 第一步
2. 第二步
3. 第三步
列表项之间留空行会中断列表。 如果需要段落,在列表项下方缩进两个空格再写。
引用块
用 > 表示引用:
text
> 这是一段引用文字。
> 可以多行。
>
> 空一行可以分段。
代码块
用三个反引号包裹,可指定语言实现语法高亮:
markdown
```python
def hello():
print("Hello, World!")
```
常用语言标识:python、javascript、bash、json、yaml、sql、html、css
表格
text
| 列1 | 列2 | 列3 |
|-----|-----|-----|
| 内容 | 内容 | 内容 |
| 内容 | 内容 | 内容 |
对齐方式:
text
| 左对齐 | 居中 | 右对齐 |
|:-------|:----:|-------:|
| 内容 | 内容 | 内容 |
图片
text

分割线
三个或以上的 -、* 或 _:
text
---
链接
行内链接:
text
[显示文字](https://example.com)
引用式链接(适合长 URL):
text
[显示文字][ref]
[ref]: https://example.com "可选的标题"
转义字符
需要在文本中显示 *、#、_ 等特殊符号时,在前面加 \:
text
\*这不是斜体\*
\# 这不是标题
完整示例
markdown
# 项目说明
## 安装
```bash
npm install
```
## 使用
1. 导入模块
2. 配置参数
3. 启动服务
## 配置项
| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| port | number | 3000 | 服务端口 |
| host | string | localhost | 主机地址 |
> 更多信息参见 [官方文档](https://example.com/docs)。
**注意:** 生产环境请务必修改默认端口。
速查表
text
标题 # ## ### ####
粗体 **text**
斜体 *text*
删除线 ~~text~~
行内代码 `code`
链接 [text](url)
图片 
引用 > quote
无序列表 - item
有序列表 1. item
代码块 ```lang
表格 | col | col |
分割线 ---
转义 \char