4574字
16分钟

Markdown扩展示例

文章示例
Markdown

Markdown 扩展

容器

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

信息框容器

INFO

This is an info box.

TIP

This is a tip.

WARNING

This is a warning.

DANGER

This is a dangerous warning.

DETAILS

This is a details block.

可以通过在容器的 "type" 之后附加文本来设置自定义标题

STOP

危险区域,请勿继续

点我查看代码

GitHub 风格的警报

Note

强调用户在快速浏览文档时也不应忽略的重要信息。

Tip

有助于用户更顺利达成目标的建议性信息。

Important

对用户达成目标至关重要的信息。

Warning

因为可能存在风险,所以需要用户立即关注的关键内容。

Caution

行为可能带来的负面影响。

特殊代码块

语法高亮

Emoji

有两种方法可以将表情符号添加到 Markdown 文件中:将表情符号复制并粘贴到 Markdown 格式的文本中,或者键入 emoji shortcodes。

键入表情简码:😂

直接复制:😂

上下角标

19th

H2O

脚注

脚注是对文本的补充说明,通过 [^ 替代文本] 创建

需要补充说明的内容 1

任务列表

清单列表再选项前面加 - [ ] 实现可勾选的列表。

  • 未选择
  • 已选择

数学公式

LaTeX 是一个强大的排版系统,特别适用于包含复杂数学公式的文档。

当你需要在编辑器中插入数学公式时,可以使用一个或两个美元符 $ 包裹 TeX 或 LaTeX 格式的数学公式来实现。

行内公式:文本中的变量 x=5x = 5 和函数 f(x)=x2+2x+1f(x) = x^2 + 2x + 1。

块级公式: E=mc2E = mc^2

多行公式:

f(x)=ax2+bx+cf′(x)=2ax+bf′′(x)=2a\begin{align} f(x) &= ax^2 + bx + c \\ f'(x) &= 2ax + b \\ f''(x) &= 2a \end{align}

图表

Mermaid(美人鱼)是一个基于 JavaScript 的图表和图形工具,允许用文本语法来描述文档图形 (流程图、 时序图、甘特图) 的工具,您可以在文档中嵌入一段 mermaid 文本来生成 SVG 形式的图形

流程图(Flowchart)

流程图用于表示流程或算法。

图表加载中...

时序图(Sequence Diagram)

时序图用于显示对象之间的交互,按时间顺序排列。

图表加载中...

类图(Class Diagram)

类图用于显示系统中的类、属性、方法以及它们之间的关系。

图表加载中...

甘特图(Gantt Chart)

甘特图用于项目管理,显示项目、任务和里程碑的时间线。

图表加载中...

饼图(Pie Chart)

饼图用于显示数据的比例关系。

图表加载中...

状态图(State Diagram)

状态图用于描述系统或对象的不同状态及其转换。

图表加载中...

实体关系图(Entity Relationship Diagram)

ER 图用于数据库设计,显示实体及其关系。

图表加载中...

旅程图(Journey Diagram)

旅程图用于显示用户体验或流程中的不同阶段和满意度。

图表加载中...

git 图表(Git Graph)

图表加载中...

参考资料

Markdown 增强

在 VitePress 中使用 Mermaid 图表 | Jay's Blog

Footnotes

  1. 这里是脚注内容 ↩