Markdown Toolbox Logo Markdown Toolbox
家
博客

备忘单 - GitHub 风格的 Markdown

2023-12-12

GitHub 风格的 Markdown (GFM) 扩展了标准 Markdown 语法，以包括一些特定于 GitHub 的附加特性。本速查表涵盖 GFM 的关键方面，使创建 README、问题和其他 GitHub 文档变得更加容易。

扩展语法

任务列表

  • 使用 - [ ] 创建未完成的任务列表，使用 - [x] 创建已完成的任务。

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

删除线

  • 使用双波浪号 ~~ 来删除文本。

    ~~删除线~~

表格

  • 使用短横线 - 和管道符 | 创建表格。

    | 表头 1 | 表头 2 |
| -------- | -------- |
| 行 1    | 数据 1   |
| 行 2    | 数据 2   |

封闭代码块

  • 使用三个反引号 (```) 并指定语言以进行语法高亮显示。

    ```javascript console.log("你好，世界！"); ```

提到用户和团队

  • 使用 @username 来提到用户或团队。

问题和拉取请求引用

  • 使用 # 引用问题和拉取请求。

标准 Markdown 语法

标题

  • 使用 # 作为标题。更多的 # 表示更小的标题。

文本格式

  • 粗体: **粗体**
  • 斜体: *斜体*
  • 粗体和斜体: ***粗体和斜体***

列表

  • 无序列表: 以 -、+ 或 * 开头。
  • 有序列表: 以数字加 . 开头。

链接和图像

  • 链接: [标题](URL)
  • 图像: ![替代文本](URL)

引用

  • 使用 > 来表示引用。

GitHub 的 Markdown 允许更互动和动态的文档，尤其在协作项目的上下文中很有用。