← 返回教程列表
Markdown 语法指南:带示例的完整参考
· 标签: markdown-syntax, markdown-guide, markdown-formatting, github-flavored-markdown, markdown-reference
Markdown 语法指南
Markdown 是一种轻量级标记语言,可将纯文本转换为格式化的 HTML。它由 John Gruber 于 2004 年创建,如今已成为整个 Web 上文档、README 文件和技术内容的标准书写格式。
标题
使用 # 符号。一个 # 表示最高层级,最多六个表示最低层级:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
层级每次应递增一级——从 ## 跳到 #### 可能会让屏幕阅读器产生困惑。
文本格式
**Bold text** or __Bold text__
*Italic text* or _Italic text_
**_Bold and italic_**
~~Strikethrough text~~
链接
[Link text](https://example.com)
[Link with title](https://example.com "Title")
[Reference-style][ref-id]
[ref-id]: https://example.com
<contact@example.com>
图片

[](https://example.com)
替代文本对可访问性和 SEO 至关重要——当图片加载失败时,它会显示出来。
列表
无序列表使用 -、* 或 +。有序列表使用数字:
- Item one 1. First item
- Item two 2. Second item
- Nested item 1. Nested item
代码
行内代码使用单个反引号:`printf()`。
代码块使用三个反引号,并可选地指定语言标识符:
```python
def greet(name):
return f"Hello, {name}!"
支持的语言:`javascript`、`python`、`html`、`css`、`json`、`bash`、`sql`、`yaml`。
## 引用
```markdown
> This is a blockquote.
> > Nested blockquotes are supported.
常用于提示框、注释以及引用外部来源。
水平分隔线
在一行中使用三个或更多个连字符、星号或下划线:
---
***
___
表格
竖线和连字符定义列。冒号控制对齐方式:
| Left | Center | Right |
| :--- | :----: | ----: |
| A1 | B1 | C1 |
GitHub 风格 Markdown 扩展
GitHub 风格 Markdown(GFM)增加了一些实用的功能:
- [x] Completed task # Task lists
- [ ] Incomplete task
:smile: :rocket: :warning: # Emoji shortcodes
~~Strikethrough text~~ # Strikethrough
GFM 还会自动链接 URL——www.example.com 无需包裹在 < > 中即可点击。
转义特殊字符
在字符前加上 \ 即可显示 Markdown 的字面字符:
\*This is not italic\*
\# This is not a heading
需要转义的字符:\ ` * _ { } [ ] ( ) # + - . ! | ~。
在线 Markdown 预览
使用 Markdown 预览工具即可实时书写和预览 Markdown。实时预览会随你的输入而更新,准确展示标题、链接、图片、代码块和表格将如何渲染。