跳转到主要内容
Xiaochen004hao 的 博客

Markdown 提示框

/ 3 min read

更新于:
目录

什么是提示框

提示框(也称为 “旁注”) 对于提供与您的内容相关的支持和/或补充信息非常有用。

如何使用它们

要在 Astro Cactus 中使用提示框,请将您的 Markdown 内容包裹在一对三重冒号 ::: 中。第一对还应包含您想要使用的提示框类型。

例如,使用以下 Markdown:

:::note
突出显示用户在浏览时也应考虑的信息。
:::

输出:

提示框类型

目前支持以下提示框类型:

  • note(笔记)
  • tip(提示)
  • important(重要)
  • warning(警告)
  • caution(注意)

笔记

:::note
突出显示用户在浏览时也应考虑的信息。
:::

提示

:::tip
可选信息,帮助用户更成功。
:::

重要

:::important
用户成功所需的关键信息。
:::

注意

:::caution
操作的潜在负面后果。
:::

警告

:::warning
由于潜在风险,需要用户立即关注的关键内容。
:::

自定义提示框标题

您可以使用以下标记自定义提示框标题:

:::note[我的自定义标题]
这是一个带有自定义标题的笔记。
:::

输出:

GitHub 仓库卡片

您可以添加链接到 GitHub 仓库的动态卡片,在页面加载时,仓库信息将从 GitHub API 中提取。

Lorem ipsum dolor sit amet, consectetur adipiscing elit.
00K00KMIT

您也可以链接 GitHub 用户:

00K00K

要使用此功能,您只需使用 “Github” 指令:

链接仓库
::github{repo="chrismwilliams/astro-theme-cactus"}
链接用户
::github{user="withastro"}