markdown github

### 如何在 GitHub 上使用 Markdown

#### 基本语法介绍
Markdown 是一种轻量级标记语言，旨在使人们能够以易读易写纯文本格式编写文档[^3]。GitHub 支持扩展版本的 Markdown 称为 GitHub Flavored Markdown (GFM)，它增加了额外的功能来支持 Git 和 GitHub 的特性。

#### 文档结构
- **标题**: 使用 `#` 来创建不同级别的标题，从一级到六级分别对应于单个至六个井号。

  # 这是一级标题
  ## 这是二级标题
  ### 这是三级标题

- **列表**: 可以为有序或无序列表，通过星号、加号或是减号作为项目符号；对于编号列表，则只需简单地输入数字加上句点即可。

  * 无序项一
  * 无序项二
  
  1. 编号项一
  2. 编号项二

- **链接与图片**: 链接采用方括号包裹文字部分并紧随圆括号内的 URL 地址形式表示。而图像则是在前面添加感叹号 ! 符号。

  [访问我的博客](http://example.com/)
  ![alt text](image- **代码块显示**: GFM 提供了特别好的代码高亮支持，允许指定编程语言以便更好地呈现源码片段。这可以通过三个反引号包围起来实现，并紧跟其后的语言名称。

def hello_world():
print('Hello, world!')

- **表格制作**: 表格可以方便地展示数据对比等内容，利用竖线 | 分隔列以及破折号 - 定义表头下的分界线。

| 列A | 列B |
| ------ | ------- |
| 数据a1 | 数据b1 |
| 数据a2 | 数据b2 |

- [x]` 标记已完成状态。

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

#### 实际应用案例
为了更直观理解这些规则，在实际操作中可能会遇到如下场景：

假设要提交一个新的 Pull Request 描述变更详情时，可能这样书写：

Fixes bug where clicking on the 'Submit' button does nothing.

Changes proposed in this pull request:
- Update JavaScript function to handle form submission correctly.
- Add unit tests covering new functionality.

上述例子展示了如何清晰简洁地传达信息给其他开发者[^1]。