使用 1~6 个 # 符号,后跟空格。
# 一级标题 (H1)
## 二级标题 (H2)
### 三级标题 (H3)
#### 四级标题 (H4)
##### 五级标题 (H5)
###### 六级标题 (H6)效果:
另一种方式(仅 H1 和 H2):
一级标题
========
二级标题
--------| 样式 | 语法 | 示例 | 效果 |
|---|---|---|---|
| 粗体 | **文本** 或 __文本__ |
**粗体文本** |
粗体文本 |
| 斜体 | *文本* 或 _文本_ |
_斜体文本_ |
斜体文本 |
| 粗斜体 | ***文本*** |
***粗斜体*** |
粗斜体 |
~~文本~~ |
~~删除线~~ |
注意:GitHub 支持嵌套,如
**粗体中_斜体_** → 粗体中_斜体_。
或使用
<br>。> 这是一级引用
>> 这是一级引用中的二级引用
>>> 三级引用效果: > 这是一级引用 >> 这是一级引用中的二级引用
无序列表:
- 项目1
- 子项目1
- 项目2
* 也可以用星号
+ 或者加号有序列表:
1. 第一项
2. 第二项
1. 子项
5. 序号可以不连续,GitHub 会自动修正任务列表(GFM 扩展,可交互复选框):
- [x] 已完成任务
- [ ] 未完成任务
- [ ] 子任务效果:
行内代码:用反引号 ` 包裹。
使用 `git status` 查看状态。代码块(推荐使用围栏代码块):
```python
def hello():
print("Hello, GitHub!")指定语言后 GitHub 会自动语法高亮。支持数百种语言(如
javascript、java、bash、yaml、markdown
等)。
---
***
___效果:
行内链接:
[链接文字](https://github.com "可选标题")引用式链接:
[链接文字][1]
[1]: https://github.com "可选标题"自动链接(GFM 扩展):
https://github.com
会自动变成可点击链接。user@example.com 也会自动链接。相对链接(推荐用于仓库内):
[README](./README.md)
[图片](../images/pic.png)示例:
<!-- markdownlint-disable-line MD044 -->支持相对路径、GitHub 仓库内的图片、外部 URL。
| 左对齐 | 居中 | 右对齐 |
| :----- | :--: | -----: |
| 内容 | 内容 | 内容 |
| 内容 | 内容 | 内容 |效果:
| 左对齐 | 居中 | 右对齐 |
|---|---|---|
| 内容 | 内容 | 内容 |
:
控制对齐(左::-、居中::-:、右:-:)。这是一个脚注引用[^1]。
[^1]: 这里是脚注的详细解释。用反引号或 \ 转义:
\* 这不会变成斜体 \*GitHub Markdown 允许有限的 HTML 标签(如
<br>、<kbd>、<details>
等),但出于安全原因会过滤危险标签。
折叠内容示例:
<details>
<summary>点击展开</summary>
这里是隐藏内容。
</details>@用户名
会通知对方。#123
会自动链接到本仓库的 Issue 123。:smile: →
😄(完整列表见 emoji cheat sheet)。Mermaid 图表(部分 GitHub 上下文支持):
```mermaid
graph TD;
A-->B;
```数学公式(部分地方支持
KaTeX):$E=mc^2$ 或 $$...$$。
小贴士: