Brain Archive

Github Flavored Markdown

6分钟阅读

GitHub支持一种拓展的Markdown语法，也被称为 GitHub Flavored Markdown

Tip

也就是说GFM支持所有的标准Markdown语法

Tip

GFM 是 Markdown 的一种“方言”，Obsidian Markdown 也是 Markdown 的一种“方言”，尽管这两个标准有部分重合，但是这两种风格不一定互相兼容

表格

表格是一个多行的结构

|表头1|表头2|表头3|
|---|---|---|
|v1|v2|v3|
|v4|v5|v6|
|v7|v8|v9|

效果如下

表头1表头2表头3
v1v2v3
v4v5v6
v7v8v9

Note

表格有很多坑

表头和分隔行是必须的 第二行的 --- 是必须的，否则不会被识别成表格

表格内不能换行，如果真的需要的话，请使用html标签<br>

Tip

表格可以设置如何对其，默认情况下是左对齐

|左对齐|居中|右对齐|
|:---|:---:|---:|
|1|2|3|
|4|5|6|

效果如下

左对齐居中右对齐
123
456

删除线 (划掉)

~~删除线~~

在~~里面的字会变成 我被删了。

颜色代码块

在GFM里，行内代码块的功能被拓展了

当行内代码块是一个颜色标签的时候，会显示一个对应颜色的小色块

这是白色`#ffffff`

Warning

本平台不支持渲染所有的GFM风格markdown，所以此处没有渲染结果

颜色模型语法示例(都使用白色)
HEX(16进制RGB)#RRGGBB#FFFFFF
RGBrgb(R,G,B)rgb(255,255,255)
HSLhsl(H,S,L)hsl(0,0%,100%)

网址/链接

在GFM里，你的网址会默认变成链接

 
https://github.com

会被渲染成

https://github.com

任务列表

在GFM里，列表进行了加强

这是一个有序列表的任务列表
 
1. [X] 第一步
2. [x] 第二步
3. [ ] 第三步
       
这是一个无序列表的任务列表
 
- [X] 功能1
- [ ] 功能2
	- [x] 子功能1
	- [ ] 子功能2

效果如下

这是一个有序列表的任务列表

  1. 第一步
  2. 第二步
  3. 第三步

这是一个无序列表的任务列表

  • 功能1
  • 功能2
    • 子功能1
    • 子功能2

Tip

有几个表示完成的方法: [x] [X]，表示未完成是[ ]（中间有个空格）

Warning

为了防止出现以下和链接的冲突

- [ ] (optional) 可选功能1

请使用 \ 转义，就像下面一样

- [ ] \(optional) 可选功能

标注

在GFM里，对引用进行了升级，支持了新的语法

> [!NOTE]
> 
> 这是个note
 
> [!TIP]
> 
> 这是个tip
 
> [!IMPORTANT]
> 
> 这是个重要信息
 
> [!WARNING]
> 
> 这是一个警告
 
> [!CAUTION]
> 
> 这是一个注意

Warning

本平台不支持渲染所有的GFM风格markdown，所以此处渲染结果可能有误，和Github渲染可能不一致

渲染效果如下

NOTE

这是个note

TIP

这是个tip

IMPORTANT

这是个重要信息

WARNING

这是一个警告

CAUTION

这是一个注意

脚注

GFM加入了一种新的语法，脚注。这个东西蛮容易上手的

Linqaqe[^1]: ciallo~[^2]
 
[^1]: Linqaqe 是 Moco 的好友
[^2]: ciallo~ 是柚子社女孩们常用于打招呼的问候语

效果如下

Linqaqe1: ciallo~2

emoji

GFM 加入了对emoji的支持

:grinning:

渲染为

😀

CAUTION

本平台不支持渲染所有的GFM风格markdown，所以此处渲染结果是手动输入的emoji，并不是渲染结果

Tip

更多emoji可以去emoji-cheat-sheet上查找

代码块高亮

在GFM里，多行代码块可以根据你选择的语言进行高亮

```python
print("hello world")
```

效果如下

print("hello world")

Tip

GitHub支持一种特殊的语法高亮(+开头是绿色，-开头是红色)，DIFF，使用方法如下

```diff  
+ 新增内容  
- 删除内容
```

效果如下

+ 新增内容  
- 删除内容

@某人

@MocoOwO

会渲染成

@MocoOwO

并且同时通知这个用户

Issue / PR / Commit 自动链接

在GFM里，#123 会自动变成 issue 链接

你也可以username/repo#123 跨仓库使用

标题链接

在GFM里，锚点可以被自动生成

# My Title
 
[跳转](#my-title)

这样你就可以快速的跳转到文件的某个位置

Warning

本平台不支持渲染所有的GFM风格markdown，所以此处没有渲染结果

Footnotes

  1. Linqaqe 是 Moco 的好友 ↩

  2. ciallo~ 是柚子社女孩们常用于打招呼的问候语 ↩

关系图谱

反向链接