From 6bed0f26242fa6182e7789a1d631907673685d20 Mon Sep 17 00:00:00 2001 From: ZhenShuo Leo <98386542+ZhenShuo2021@users.noreply.github.com> Date: Tue, 1 Jul 2025 00:21:58 +0800 Subject: [PATCH] docs: document showSummary option in article shortcode --- exampleSite/content/docs/shortcodes/index.it.md | 1 + exampleSite/content/docs/shortcodes/index.ja.md | 1 + exampleSite/content/docs/shortcodes/index.md | 2 ++ exampleSite/content/docs/shortcodes/index.zh-cn.md | 2 ++ 4 files changed, 6 insertions(+) diff --git a/exampleSite/content/docs/shortcodes/index.it.md b/exampleSite/content/docs/shortcodes/index.it.md index a5bfdd81..42aaaeb2 100644 --- a/exampleSite/content/docs/shortcodes/index.it.md +++ b/exampleSite/content/docs/shortcodes/index.it.md @@ -72,6 +72,7 @@ This is an error! | Parameter | Description | | --------- | -------------------------------------------------------- | | `link` | **Required.** the `.RelPermalink` to the target article. | +| `showSummary` | **Optional.** A boolean value indicating whether to show the article summary. If not set, the site's default configuration will be used. | **Example:** diff --git a/exampleSite/content/docs/shortcodes/index.ja.md b/exampleSite/content/docs/shortcodes/index.ja.md index ff728e09..6cb83f3e 100644 --- a/exampleSite/content/docs/shortcodes/index.ja.md +++ b/exampleSite/content/docs/shortcodes/index.ja.md @@ -72,6 +72,7 @@ Twitter で私を[フォロー](https://twitter.com/nunocoracao)するのを忘 | パラメータ | 説明 | | --------- | -------------------------------------------------------- | | `link` | **必須** ターゲット記事への `.RelPermalink`。 | +| `showSummary` | **任意。** 記事の要約を表示するかどうかを示すブール値。設定されていない場合、サイトのデフォルト設定が使用されます。 | **例:** diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md index 43f45ab0..052a2e81 100644 --- a/exampleSite/content/docs/shortcodes/index.md +++ b/exampleSite/content/docs/shortcodes/index.md @@ -72,6 +72,8 @@ This is an error! | Parameter | Description | | --------- | -------------------------------------------------------- | | `link` | **Required.** the `.RelPermalink` to the target article. | +| `showSummary` | **Optional.** A boolean value indicating whether to show the article summary. If not set, the site's default configuration will be used. | + **Example:** diff --git a/exampleSite/content/docs/shortcodes/index.zh-cn.md b/exampleSite/content/docs/shortcodes/index.zh-cn.md index 8d9886b2..acd32b4a 100644 --- a/exampleSite/content/docs/shortcodes/index.zh-cn.md +++ b/exampleSite/content/docs/shortcodes/index.zh-cn.md @@ -72,6 +72,8 @@ This is an error! | 参数 | 功能 | | ------ | ------------------------------------- | | `link` | **必填** 要嵌入文章的 `.RelPermalink` | +| `showSummary` | **可选。** 一个布尔值，指示是否显示文章摘要。如果未设置，将使用站点的默认配置。 | + **例如：**