字号
889 字
4 分钟
Markdown 扩展功能
GitHub 仓库卡片#
您可以添加链接到 GitHub 仓库的动态卡片,在页面加载时,仓库信息会从 GitHub API 获取。
CuteLeaf
/
Firefly
Waiting for api.github.com...
00K
0K
0K
Waiting...使用代码 ::github{repo="CuteLeaf/Firefly"} 创建 GitHub 仓库卡片。
1::github{repo="CuteLeaf/Firefly"}提醒框(Admonitions)配置#
Firefly 采用了 rehype-callouts 插件,支持了三种风格的提醒框主题:GitHub、Obsidian 和 VitePress。您可以在 src/config/siteConfig.ts 中进行配置:
1export const siteConfig: SiteConfig = {2 // ...3 rehypeCallouts: {4 // 选项: "github" | "obsidian" | "vitepress"5 theme: "github",6 },7 // ...8};注意:更改配置后需要重启开发服务器才能生效。
以下是各个主题支持的类型列表,每个主题风格和语法不同,可根据喜好选择。
1. GitHub 主题风格#
这是 GitHub 官方支持的 5 种基本类型。

基本语法
1> [!NOTE] NOTE2> 突出显示用户应该考虑的信息。3
4> [!TIP] TIP5> 可选信息,帮助用户更成功。6
7> [!IMPORTANT] IMPORTANT8> 用户成功所必需的关键信息。9
10> [!WARNING] WARNING11> 关键内容,需要立即注意。12
13> [!CAUTION] CAUTION14> 行动的负面潜在后果。15
16> [!NOTE] 自定义标题17> 这是一个带有自定义标题的示例。2. Obsidian 主题风格#
Obsidian 风格支持非常丰富的类型和别名。
点击展开 Obsidian 语法列表
1> [!NOTE] NOTE2> 通用的笔记块。3
4> [!ABSTRACT] ABSTRACT5> 文章的摘要。6
7> [!SUMMARY] SUMMARY8> 文章的总结(同 Abstract)。9
10> [!TLDR] TLDR11> 太长不看(同 Abstract)。12
13> [!INFO] INFO14> 提供额外信息。15
16> [!TODO] TODO17> 需要完成的事项。18
19> [!TIP] TIP20> 实用技巧或提示。21
22> [!HINT] HINT23> 暗示(同 Tip)。24
25> [!IMPORTANT] IMPORTANT26> 重要信息(Obsidian 风格通常使用类似的图标)。27
28> [!SUCCESS] SUCCESS29> 操作成功。30
31> [!CHECK] CHECK32> 检查通过(同 Success)。33
34> [!DONE] DONE35> 已完成(同 Success)。36
37> [!QUESTION] QUESTION38> 提出问题。39
40> [!HELP] HELP41> 寻求帮助(同 Question)。42
43> [!FAQ] FAQ44> 常见问题(同 Question)。45
46> [!WARNING] WARNING47> 警告信息。48
49> [!CAUTION] CAUTION50> 注意事项(同 Warning)。51
52> [!ATTENTION] ATTENTION53> 引起注意(同 Warning)。54
55> [!FAILURE] FAILURE56> 操作失败。57
58> [!FAIL] FAIL59> 失败(同 Failure)。60
61> [!MISSING] MISSING62> 缺失内容(同 Failure)。63
64> [!DANGER] DANGER65> 危险操作警告。66
67> [!ERROR] ERROR68> 错误信息(同 Danger)。69
70> [!BUG] BUG71> 报告软件缺陷。72
73> [!EXAMPLE] EXAMPLE74> 展示一个例子。75
76> [!QUOTE] QUOTE77> 引用一段话。78
79> [!CITE] CITE80> 引证(同 Quote)。81
82> [!NOTE] 自定义标题83> 这是一个带有自定义标题的示例。
3. VitePress 主题风格#
VitePress 风格提供了一套现代化的、扁平的默认样式。目前仅包含与 GitHub 一致的 5 种 基础类型。
点击展开 VitePress 语法列表
1> [!NOTE] NOTE2> 对应 GitHub 的 Note。3
4> [!TIP] TIP5> 对应 GitHub 的 Tip。6
7> [!IMPORTANT] IMPORTANT8> 对应 GitHub 的 Important。9
10> [!WARNING] WARNING11> 对应 GitHub 的 Warning。12
13> [!CAUTION] CAUTION14> 对应 GitHub 的 Caution。15
16> [!TIP] 自定义标题17> VitePress 风格同样支持自定义标题。
4. Docusaurus 风格语法#
仅支持语法,风格保持跟上面三个主题相同。
点击展开 Docusaurus 语法列表
支持以下类型的提醒框:note tip important warning caution
1:::note2突出显示用户应该考虑的信息,即使在快速浏览时也是如此。3:::4
5:::tip6可选信息,帮助用户更成功。7:::8
9:::important10用户成功所必需的关键信息。11:::12
13:::warning14由于潜在风险需要用户立即注意的关键内容。15:::16
17:::caution18行动的负面潜在后果。19:::20
21:::tip[自定义标题]22可选信息,帮助用户更成功。23:::剧透#
您可以为文本添加剧透。文本也支持 Markdown 语法。
内容
1内容 :spoiler[被隐藏了 **哈哈**]!支持与分享
如果这篇文章对你有帮助,欢迎分享给更多人或赞助支持!
Markdown 扩展功能
https://kangxia.top/posts/markdown-extended/ 最后更新于 2026-02-03,距今已过 237 天
部分内容可能已过时