提示框

提示框#

提示框（也称为标注框）用于突出显示与页面叙述略有不同的特定文本块，例如注释或警告。

提示框是 directive 插件的一种特殊情况。建议使用 colon_fence 插件来创建提示框，这表示块内容也是 MyST Markdown 格式。

:::{tip}
Let's give readers a helpful hint!
:::

小技巧

Let’s give readers a helpful hint!

1. 提示类型#

以下是可用的核心提示框类型：

这些提示框不需要参数，但可以通过选项进行配置：

class:: 以空格分隔的 CSS 类列表，将添加到提示框中，符合标识符规范化规则。
name:: 提示框的引用目标（参见交叉引用）。

:::{tip}
:class: myclass1 myclass2
:name: a-tip-reference
Let's give readers a helpful hint!
:::

[Reference to my tip](#a-tip-reference)

小技巧

Let’s give readers a helpful hint!

Reference to my tip

Sphinx 还添加了许多额外的提示框类型，用于表示文档或代码库的更改：

:::{versionadded} 1.2.3
Explanation of the new feature.
:::

:::{versionchanged} 1.2.3
Explanation of the change.
:::

:::{deprecated} 1.2.3
Explanation of the deprecation.
:::

Added in version 1.2.3: 新功能的说明。

在 1.2.3 版本发生变更: 更改的说明。

自 1.2.3 版本弃用: 弃用的说明。

2. 提示框标题#

要为提示框提供自定义标题，请使用 admonition 指令。如果您还想将提示框样式设置为核心提示框类型之一，可以使用 admonition 指令并添加 class 选项。

:::{admonition} My custom title with *Markdown*!
:class: tip

This is a custom title for a tip admonition.
:::

My custom title with Markdown!

This is a custom title for a tip admonition.

3. 可折叠的提示框#

sphinx-togglebutton 插件允许您通过向提示框添加 dropdown 类来创建可折叠的提示框。

:::{note}
:class: dropdown

This admonition has been collapsed,
meaning you can add longer form content here,
without it taking up too much space on the page.
:::

备注

此提示框已折叠，这意味着您可以在此处添加较长的内容，而不会占用页面太多空间。

4. 其他容器（网格、选项卡、卡片等）#

使用 colon_fence 插件，内容块可以包裹在具有自定义 CSS 类的容器中。

:::bg-primary
This is a container with a custom CSS class.

- It can contain multiple blocks
:::

This is a container with a custom CSS class.

It can contain multiple blocks

使用 sphinx-design 插件，还可以创建美观且适应屏幕尺寸的网页组件。

:::{card} Card Title
Header
^^^
Card content
+++
Footer
:::

Header

Card Title

Card content

Footer

::::{tab-set}

:::{tab-item} Label1
Content 1
:::

:::{tab-item} Label2
Content 2
:::

::::

Label1

Content 1

Label2

Content 2

提示框

目录