Markdown 语法

注意

Markdown 在不同环境下语法会有细微差别，实际渲染效果也不完全相同，请根据所在环境查找相应文档。

基础语法

基本撰写和格式语法
使用简单的语法在 GitHub 上为您的散文和代码创建复杂的格式。

Markdown 备忘清单
https://quickref.cn/docs/markdown.html

Markdown cheatsheet
https://cheatsheets.zip/markdown

待办任务列表

关于任务列表
您可以使用任务列表将议题或拉取请求的工作分解为较小的任务，然后跟踪要完成的整套工作。

表格

使用表格组织信息
您可以创建表格来组织评论、议题、拉取请求和 wiki 中的信息。

提示

警报
警报是基于块引用语法的 Markdown 扩展，可用于强调关键信息。 在 GitHub 上，它们以独特的颜色和图标显示，以指示内容的显著性。

自定义容器
自定义容器可以通过它们的类型、标题和内容来定义。

折叠

使用折叠部分组织信息
可创建带 <details> 标记的折叠部分来简化 Markdown。

自定义容器
自定义容器可以通过它们的类型、标题和内容来定义。

代码块

VitePress 相关衍生

代码块中的语法高亮
按照特定的语法对代码块中的文本进行着色。

在代码块中实现行高亮
提升某一些行的亮度，以与其它行形成鲜明对比。

代码块中聚焦
默认情况下模糊其它行，只保留某一些行的正常显示；在鼠标移动上去时显示所有的行。

代码块中的颜色差异
使用红色、绿色表示代码中某一些行的增删改动，类似于 git 的展示效果。

代码块中的行号
https://vitepress.dev/zh/guide/markdown#line-numbers

Bundled Languages - Shiki
https://shiki.style/languages

GitHub

创建和突显代码块
通过围栏代码块和启用语法突显来分享代码样本。

关系图

Mermaid
https://mermaid.js.org/intro/

创建 Mermaid 关系图
Mermaid 是一款受 Markdown 启发的工具，可将文本呈现为关系图。 例如，Mermaid 可以呈现流程图、序列图、饼图等。

数学公式

提示

本质上是 LaTex 代码，参考其语法来编写即可。

LaTeX 备忘清单
本备忘单总结了 LaTeX 常用显示数学符号的参考列表和一些 KaTeX 的应用示例。

LaTeX cheatsheet
This cheat sheet summarizes a reference list of LaTeX commonly used display math notation and some application examples of KaTeX.

VitePress 配置

LaTeX cheatsheet
https://vitepress.dev/zh/guide/markdown#math-equations

GitHub 指引

编写数学表达式
使用 Markdown 在 GitHub 上显示数学表达式。

自动链接（仅GitHub）

自动链接引用和 URL
对 URL、议题、拉取请求和提交的引用会自动缩短并转换为链接。

参考

GitHub Flavored Markdown Spec
https://github.github.com/gfm/