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` | コールアウトのタイプ。(デフォルト、`info``warning``error`) |
| `emoji` | コールアウトの前に表示される絵文字。 |
| `icon` | コールアウトの絵文字 (タイプに関連、またはカスタム絵文字にすることもできます)。 |