384 字
2 分钟
扩展功能
GitHub 仓库卡片(GitHub Repository Cards)
你可以在页面中添加动态的 GitHub 仓库卡片。
页面加载时,仓库信息会通过 GitHub API 自动获取并展示。
示例:
Waiting for api.github.com...
创建 GitHub 仓库卡片的语法如下:
::github{repo="Spr-Aachen/Twilight"}提示框(Admonitions)
支持以下类型的提示框:
note tip important warning caution
示例:
NOTE这是需要用户注意的信息,即使快速浏览也应留意。
TIP这是可选的补充信息,帮助用户更好地完成任务。
IMPORTANT这是用户成功所必需的重要信息。
WARNING这是需要用户立即注意的关键信息,可能涉及风险。
CAUTION这是提醒用户某个操作可能带来负面后果。
基本语法
:::note这是需要用户注意的信息,即使快速浏览也应留意。:::
:::tip这是可选的补充信息,帮助用户更好地完成任务。:::自定义标题
提示框的标题可以自定义:
自定义标题这是一个带有自定义标题的提示框。
:::note[自定义标题]这是一个带有自定义标题的提示框。:::GitHub 风格语法(GitHub Syntax)
TIP
也支持 GitHub 风格的提示框语法。
参考:GitHub 官方说明
示例:
> [!NOTE]> 这是一个 GitHub 风格的 NOTE 提示框。
> [!TIP]> 这是一个 GitHub 风格的 TIP 提示框。隐藏文本(Spoiler)
你可以在文本中添加隐藏内容(剧透)。
隐藏内容支持 Markdown 语法。
示例:
内容
内容 :spoiler[被隐藏的 **内容**]!部分信息可能已经过时