Files
hextra_mirror/exampleSite/content/docs/guide/shortcodes/callout.zh-cn.md
Ludovic Fernandez f4d75a4e5b feat(callout): revamp of the callouts (#767)
* feat(callout): revamp of the callouts

* fix: doc

* chore: refactor gh alert

* feat: same colors on callouts and gh alerts

* docs: more relevant examples

* docs: i18n

* docs: update existing callouts
2025-08-21 23:31:16 +01:00

3.5 KiB
Raw Blame History

title, linkTitle, aliases, prev
title linkTitle aliases prev
提示框组件 提示框
callouts
/docs/guide/shortcodes

一个内置组件,用于向读者展示重要信息。

Note

v0.9.0 起支持 GitHub风格提示框。 它利用Markdown语法渲染提示框确保内容具有更好的可移植性和可读性。

示例

{{< callout >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{< callout type="info" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{< callout type="warning" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{< callout type="error" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{< callout type="important" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

默认

{{< callout >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{</* callout */>}}
  **标注** 是一小段旨在吸引注意力的文字。
{{</* /callout */>}}

Info

{{< callout type="info" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{</* callout type="info" */>}}
  **标注** 是一小段旨在吸引注意力的文字。
{{</* /callout */>}}

Warning

{{< callout type="warning" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{</* callout type="warning" */>}}
  **标注** 是一小段旨在吸引注意力的文字。
{{</* /callout */>}}

Error

{{< callout type="error" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{</* callout type="error" */>}}
  **标注** 是一小段旨在吸引注意力的文字。
{{</* /callout */>}}

Important

{{< callout type="important" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{</* callout type="important" */>}} 
  **标注** 是一小段旨在吸引注意力的文字。
{{</* /callout */>}}

自定义图标

{{< callout icon="sparkles" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{</* callout icon="sparkles" */>}}
  **标注** 是一小段旨在吸引注意力的文字。
{{</* /callout */>}}

{{< callout type="important" icon="sparkles" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{</* callout type="important" icon="sparkles" */>}}
  **标注** 是一小段旨在吸引注意力的文字。
{{</* /callout */>}}

表情符号

{{< callout emoji="🌐" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{</* callout emoji="🌐" */>}}
  **标注** 是一小段旨在吸引注意力的文字。
{{</* /callout */>}}

{{< callout type="info" emoji="" >}} 标注 是一小段旨在吸引注意力的文字。 {{< /callout >}}

{{</* callout type="info" emoji="" */>}}
  **标注** 是一小段旨在吸引注意力的文字。
{{</* /callout */>}}

选项

范围 描述
type 标注的类型。(默认、“信息”、“警告”、“错误”)
emoji 标注前显示的表情符号。
icon 标注的表情符号(与类型相关或可以是自定义表情符号)。