欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

GFM 扩展语法

程序员文章站 2022-03-30 08:42:05
...

GFM 扩展语法

GitHub Flavored Markdown(简称 GFM )

删除线

删除线的语法如下。
~~被删除内容~~

效果:
被删除内容

表情符号

使用:包裹表情代码即可,语法如下。
:表情代码:

示例:
:smile:
:laughing\:
:+1:
:-1:
:clap:

效果:
????
????
????
????
????

更多的表情符号请参考 https://www.webfx.com/tools/emoji-cheat-sheet/

自动链接

在扩展语法中,可以不使用 <> 包裹。

自动链接只识别以 www 或 http:// 开头的 URL 地址。

如果不想使用自动链接,也可以使用 ` 包裹 URL 地址。

表格

表格的语法如下。

|表头1|表头2|表头3|
|----|----|----|
|内容1|内容2|内容3|
|内容1|内容2|内容3|

语法说明如下。

  1. 单元格使用 | 来分隔,为了阅读更清晰,建议最前和最后都使用 | 。
  2. 单元格和 | 之间的空格会被移除。
  3. 表头与其他行使用 ---- 来分隔。
  4. 表格对齐格式如下。
    a. 左对齐(默认)::----
    b. 右对齐:----:
    c. 居中对齐::----:
  5. 块级元素(代码区块、引用区块)不能插入表格中。

关于创建表格的建议如下。

  1. 在表格的前、后各空 1 行。
  2. 在每一行最前和最后都使用 | ,每一行中的 | 要尽量都对齐。
  3. 不要使用庞大复杂的表格,那样会难以维护和阅读。

任务列表

任务列表的语法如下。

- [ ] 未勾选
- [x] 已勾选

语法说明如下。

  1. 任务列表以 - + 空格开头,由 [ + 空格/x + ] 组成。
  2. x 推荐使用小写。
  3. 当方括号中的字符为空格时,复选框时未选中状态,为 x 时是选中状态。

效果:

  • 未勾选
  • 已勾选

围栏代码块

在扩展语法中,围栏代码块使用连续 3 个 ` 包裹,还支持语法高亮并可以加上编程语言的名字,可以性和可维护性更强一些。

```

代码片段

```

建议围栏代码块被空行包裹。

锚点

锚点,也称为书签,用来标记文档的特定位置,使用锚点可以跳转到当前文档或其他文档中指定的标记位置。

Markdown 会被渲染成 HTML 页面,在 HTML 页面中可以通过锚点实现跳转;GitHub、GitBook项目文档中的目录也是通过锚点实现跳转的。

锚点的语法如下。
[锚点描述](#描点名)

语法说明如下。

  1. 锚点名建议使用字母和数字,当然中文也是被支持的,但不排除有些网站支持得不够好。
  2. 锚点名是区分英文大小写的。
  3. 在锚点名中不能含有空格,也不能含有特殊字符。

示例:
目录
[第01章](#第01章)
## 第01章

相关标签: Markdown