GitHub Favored Markdown

GitHub Docs

文本样式

  • 粗体 **bold** 或 __bold__ ctrl+b
  • 斜体 *italic* 或 _italic_ ctrl+i
  • 粗体和斜体可以嵌套
  • 粗斜体 ***bold italic***
  • 删除线 ~~strikethrough~~ 或 ~strikethrough~
  • 下标 <sub>subscript</sub>
  • 上标 <sup>superscript</sup>
  • 下划线 <ins>underline</ins>

单行代码

ctrl+e

颜色

使用单行代码包裹rgb,hex,hsl颜色

链接

ctrl+k

也可以通过这种方法链接到仓库中的其他文件

图片

![]()

也可以通过这种方法链接仓库中的图片

还可以使用HTML的 picture 标签

任务列表

- [ ] unfinished
- [x] finished

emojis

https://github.com/ikatyang/emoji-cheat-sheet/blob/github-actions-auto-update/README.md#github-custom-emoji

脚注

Here is a simple footnote[^1].

A footnote can also have multiple lines[^2].

[^1]: My reference.
[^2]: To add line breaks within a footnote, prefix new lines with 2 spaces.  This is a second line.

告诫

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.