docs: improve options description (#762)

This commit is contained in:
Ludovic Fernandez
2025-08-17 19:42:59 +02:00
committed by GitHub
parent 48bae073cb
commit e3ef6bcebb
20 changed files with 259 additions and 167 deletions

View File

@@ -16,68 +16,58 @@ prev: /docs/guide/shortcodes
## 示例
{{< callout emoji="👾">}}
**提示框**是一段旨在吸引注意力的简短文本。
{{< /callout >}}
{{< callout type="info" >}}
**提示框**是一段旨在吸引注意力的简短文本。
{{< /callout >}}
{{< callout type="warning" >}}
**提示框**是一段旨在吸引注意力的简短文本。
{{< /callout >}}
{{< callout type="error" >}}
**提示框**是一段旨在吸引注意力的简短文本。
{{< /callout >}}
## 使用方法
### 默认样式
### 默认
{{< callout emoji="🌐">}}
Hugo可用于创建各种类型的网站包括博客、作品集、文档站点等
**标注** 是一小段旨在吸引注意力的文字
{{< /callout >}}
```markdown
{{</* callout emoji="🌐" */>}}
Hugo可用于创建各种类型的网站包括博客、作品集、文档站点等
**标注** 是一小段旨在吸引注意力的文字
{{</* /callout */>}}
```
### 信息提示
### 信息
{{< callout type="info" >}}
请访问GitHub查看最新发布版本
**标注** 是一小段旨在吸引注意力的文字
{{< /callout >}}
```markdown
{{</* callout type="info" */>}}
请访问GitHub查看最新发布版本
**标注** 是一小段旨在吸引注意力的文字
{{</* /callout */>}}
```
### 警告提示
### 警告
{{< callout type="warning" >}}
此API将在下一版本中弃用
**标注** 是一小段旨在吸引注意力的文字
{{< /callout >}}
```markdown
{{</* callout type="warning" */>}}
此API将在下一版本中弃用
**标注** 是一小段旨在吸引注意力的文字
{{</* /callout */>}}
```
### 错误提示
### 错误
{{< callout type="error" >}}
出现错误,系统即将崩溃
**标注** 是一小段旨在吸引注意力的文字
{{< /callout >}}
```markdown
{{</* callout type="error" */>}}
出现错误,系统即将崩溃
**标注** 是一小段旨在吸引注意力的文字
{{</* /callout */>}}
```
```
## 选项
| 范围 | 描述 |
|---------|----------------------------|
| `type` | 标注的类型。(默认、“信息”、“警告”、“错误”) |
| `emoji` | 标注前显示的表情符号。 |
| `icon` | 标注的表情符号(与类型相关或可以是自定义表情符号)。 |