GitHub 特有语法 #

概述 #

GitHub Flavored Markdown (GFM) 是 GitHub 扩展的 Markdown 语法，增加了许多实用功能。

任务列表 #

基本语法 #

markdown

- [ ] 未完成任务
- [x] 已完成任务

Issues 中使用 #

markdown

## 待办事项

- [ ] 任务一
- [ ] 任务二
- [x] 任务三

GitHub 会自动显示进度条。

PR 中使用 #

markdown

## 本次更新

- [x] 新功能
- [x] Bug 修复
- [ ] 文档更新

删除线 #

markdown

~~已删除的内容~~

渲染效果：~~已删除的内容~~

表格 #

markdown

| 列1 | 列2 | 列3 |
|-----|-----|-----|
| A | B | C |
| D | E | F |

自动链接 #

URL 自动识别 #

markdown

https://github.com
www.example.com

Issue 引用 #

markdown

修复 #123
关联 user/repo#456

提交引用 #

markdown

查看 abc123def
查看 user/repo@abc123def

用户和团队提及 #

markdown

@username
@org/team

代码块 #

语法高亮 #

markdown

```javascript
const x = 1;
```

```python
x = 1
```

```ruby
x = 1
```

Diff 显示 #

markdown

```diff
- 删除的行
+ 新增的行
```

折叠内容 #

markdown

<details>
<summary>点击展开</summary>

隐藏的内容在这里。

```javascript
console.log('Hello');

```

渲染效果：

点击展开

隐藏的内容在这里。

Mermaid 图表 #

markdown

```mermaid
graph TD
    A[开始] --> B[结束]
```

警告框 #

markdown

> [!NOTE]
> 这是一个提示。

> [!WARNING]
> 这是一个警告。

> [!IMPORTANT]
> 这是重要信息。

> [!CAUTION]
> 这是注意事项。

> [!TIP]
> 这是一个技巧。

渲染效果：

[!NOTE] 这是一个提示。

[!WARNING] 这是一个警告。

快捷键 #

markdown

按 <kbd>Ctrl</kbd> + <kbd>C</kbd> 复制

渲染效果：按 Ctrl + C 复制

数学公式 #

markdown

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

块级公式：
$$
E = mc^2
$$

脚注 #

markdown

这是一个脚注[^1]。

[^1]: 脚注内容。

SHA 引用 #

markdown

查看提交 16c999e8c71134401a78d4d46435517b2271d6ac
查看提交 16c999e
查看提交 user/repo@16c999e

Issue/PR 引用 #

引用格式	说明
`#123`	当前仓库的 Issue/PR
`user/repo#123`	其他仓库的 Issue/PR
`GH-123`	明确指定 GitHub Issue

Emoji #

markdown

:smile: :heart: :thumbsup: :rocket:

渲染效果：:smile: :heart: :thumbsup: :rocket:

常用 Emoji #

Emoji	代码	用途
:sparkles:	`:sparkles:`	新功能
:bug:	`:bug:`	Bug 修复
:memo:	`:memo:`	文档更新
:rocket:	`:rocket:`	部署
:white_check_mark:	`:white_check_mark:`	测试
:lock:	`:lock:`	安全
:arrow_up:	`:arrow_up:`	依赖升级
:arrow_down:	`:arrow_down:`	依赖降级
:recycle:	`:recycle:`	重构
:fire:	`:fire:`	删除代码

README 徽章 #

markdown

[![npm](https://img.shields.io/npm/v/package)](https://npmjs.com/package/package)
[![license](https://img.shields.io/npm/l/package)](./LICENSE)
[![build](https://img.shields.io/github/actions/workflow/status/user/repo/ci.yml)](https://github.com/user/repo/actions)
[![codecov](https://img.shields.io/codecov/c/github/user/repo)](https://codecov.io/gh/user/repo)

最佳实践 #

1. 使用任务列表追踪进度 #

markdown

- [x] 已完成
- [ ] 待完成

2. 使用折叠隐藏细节 #

markdown

<details>
<summary>详细日志</summary>

日志内容…

text


</details>

3. 使用警告框突出重要信息 #

markdown

> [!WARNING]
> 重要警告信息

4. 使用 Emoji 增强可读性 #

markdown

## 更新日志

- :sparkles: 新功能
- :bug: Bug 修复
- :memo: 文档更新

下一步 #

继续学习编辑器推荐！