Skip to content

docs: improve options description #762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imfing merged 5 commits into from
Aug 17, 2025
Merged

docs: improve options description #762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
590344c
docs(cards): update documentation
ldez Aug 17, 2025
c3e384f
docs(callout): update documentation
ldez Aug 17, 2025
e99397e
docs(filetree): update documentation
ldez Aug 17, 2025
0c7d34a
docs(icon): update documentation
ldez Aug 17, 2025
e95788a
docs(badge): update documentation
ldez Aug 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 22 additions & 32 deletions exampleSite/content/docs/guide/shortcodes/callout.fa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,70 +14,60 @@ prev: /docs/guide/shortcodes
> [هشدارهای سبک GitHub](../../markdown#alerts) از [نسخه 0.9.0](https://github.com/imfing/hextra/releases/tag/v0.9.0) پشتیبانی می‌شوند.
> این ویژگی از سینتکس Markdown برای رندر کردن callout استفاده می‌کند که باعث بهبود قابلیت حمل و خوانایی محتوا می‌شود.

## مثال
## أمثلة

{{< callout emoji="👾">}}
یک **callout** متن کوتاهی است که برای جلب توجه طراحی شده است.
{{< /callout >}}

{{< callout type="info" >}}
یک **callout** متن کوتاهی است که برای جلب توجه طراحی شده است.
{{< /callout >}}

{{< callout type="warning" >}}
یک **callout** متن کوتاهی است که برای جلب توجه طراحی شده است.
{{< /callout >}}

{{< callout type="error" >}}
یک **callout** متن کوتاهی است که برای جلب توجه طراحی شده است.
{{< /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` | رمز تعبيري للنداء (مرتبط بالنوع أو يمكن أن يكون رمز تعبيري مخصصًا). |
44 changes: 17 additions & 27 deletions exampleSite/content/docs/guide/shortcodes/callout.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` | コールアウトの絵文字 (タイプに関連、またはカスタム絵文字にすることもできます)。 |
42 changes: 16 additions & 26 deletions exampleSite/content/docs/guide/shortcodes/callout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,54 +14,36 @@ A built-in component to show important information to the reader.
> [GitHub-style alerts](../../markdown#alerts) are supported since [v0.9.0](https://github.com/imfing/hextra/releases/tag/v0.9.0).
> It leverages Markdown syntax to render the callout which ensures better portability and readability of the content.

## Example

{{< callout emoji="👾">}}
A **callout** is a short piece of text intended to attract attention.
{{< /callout >}}

{{< callout type="info" >}}
A **callout** is a short piece of text intended to attract attention.
{{< /callout >}}

{{< callout type="warning" >}}
A **callout** is a short piece of text intended to attract attention.
{{< /callout >}}

{{< callout type="error" >}}
A **callout** is a short piece of text intended to attract attention.
{{< /callout >}}

## Usage
## Examples

### Default

{{< callout emoji="🌐">}}
Hugo can be used to create a wide variety of websites, including blogs, portfolios, documentation sites, and more.
A **callout** is a short piece of text intended to attract attention.
{{< /callout >}}

```markdown
{{</* callout emoji="🌐" */>}}
Hugo can be used to create a wide variety of websites, including blogs, portfolios, documentation sites, and more.
A **callout** is a short piece of text intended to attract attention.
{{</* /callout */>}}
```

### Info

{{< callout type="info" >}}
Please visit GitHub to see the latest releases.
A **callout** is a short piece of text intended to attract attention.
{{< /callout >}}

```markdown
{{</* callout type="info" */>}}
Please visit GitHub to see the latest releases.
A **callout** is a short piece of text intended to attract attention.
{{</* /callout */>}}
```

### Warning

{{< callout type="warning" >}}
This API will be deprecated in the next version.
A **callout** is a short piece of text intended to attract attention.
{{< /callout >}}

```markdown
Expand All @@ -73,11 +55,19 @@ A built-in component to show important information to the reader.
### Error

{{< callout type="error" >}}
Something went wrong and it's going to explode.
A **callout** is a short piece of text intended to attract attention.
{{< /callout >}}

```markdown
{{</* callout type="error" */>}}
Something went wrong and it's going to explode.
A **callout** is a short piece of text intended to attract attention.
{{</* /callout */>}}
```

## Options

| Parameter | Description |
|-----------|----------------------------------------------------------------------|
| `type` | The type of callout. (default, `info`, `warning`, `error`) |
| `emoji` | The emoji to show before the callout. |
| `icon` | The emoji of the callout (related to type or can be a custom emoji). |
52 changes: 21 additions & 31 deletions exampleSite/content/docs/guide/shortcodes/callout.zh-cn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` | 标注的表情符号（与类型相关或可以是自定义表情符号）。 |
25 changes: 13 additions & 12 deletions exampleSite/content/docs/guide/shortcodes/cards.fa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,25 @@ linkTitle: کارت‌ها

## پارامترهای کارت

| پارامتر | توضیحات |
|----------- |-----------------------------------------------------------------|
| پارامتر | توضیحات |
|------------|-----------------------------------------------------------|
| `link` | URL (داخلی یا خارجی). |
| `title` | عنوان کارت. |
| `subtitle` | زیرعنوان (پشتیبانی از Markdown). |
| `icon` | نام آیکون. |
| `tag` | متن تگ. |
| `tagColor` | رنگ تگ: `gray` (پیش‌فرض), `yellow`, `red` و `blue`. |
| `title` | عنوان کارت. |
| `subtitle` | زیرعنوان (پشتیبانی از Markdown). |
| `icon` | نام آیکون. |
| `tag` | متن تگ. |
| `tagType` | نوع العلامة: default (رمادي)، `info`، `warning` و`error`. |

## کارت تصویری

علاوه بر این، کارت از افزودن تصویر و پردازش آن از طریق این پارامترها پشتیبانی می‌کند:

| پارامتر | توضیحات |
|----------- |---------------------------------------------|
| `image` | آدرس تصویر کارت را مشخص می‌کند. |
| `method` | روش پردازش تصویر هوگو را تنظیم می‌کند. |
| `options` | تنظیمات پردازش تصویر هوگو را پیکربندی می‌کند. |
| پارامتر | توضیحات |
|--------------|---------------------------------------------------|
| `image` | آدرس تصویر کارت را مشخص می‌کند. |
| `method` | روش پردازش تصویر هوگو را تنظیم می‌کند. |
| `options` | تنظیمات پردازش تصویر هوگو را پیکربندی می‌کند. |
| `imageStyle` | يتم استخدامه لملء سمة النمط الخاصة بعلامة الصورة. |

کارت از سه نوع تصویر پشتیبانی می‌کند:

Expand Down
Loading