From ad1ba9905dd1d65059b2012f32a688ecb8ff4493 Mon Sep 17 00:00:00 2001 From: ZhenShuo Leo <98386542+ZhenShuo2021@users.noreply.github.com> Date: Tue, 1 Jul 2025 00:41:29 +0800 Subject: [PATCH] docs: document compactSummary option in article shortcode --- exampleSite/content/docs/shortcodes/index.it.md | 5 +++-- exampleSite/content/docs/shortcodes/index.ja.md | 7 ++++--- exampleSite/content/docs/shortcodes/index.md | 6 +++--- exampleSite/content/docs/shortcodes/index.zh-cn.md | 8 ++++---- 4 files changed, 14 insertions(+), 12 deletions(-) diff --git a/exampleSite/content/docs/shortcodes/index.it.md b/exampleSite/content/docs/shortcodes/index.it.md index 42aaaeb2..82cea40a 100644 --- a/exampleSite/content/docs/shortcodes/index.it.md +++ b/exampleSite/content/docs/shortcodes/index.it.md @@ -73,15 +73,16 @@ This is an error! | --------- | -------------------------------------------------------- | | `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. | +| `compactSummary` | **Optional.** A boolean value indicating whether to display the summary in compact mode. Default to false. | **Example:** ```md -{{}} +{{}} ``` -{{< article link="/docs/welcome/" >}} +{{< article link="/it/docs/welcome/" showSummary=true compactSummary=true >}}


diff --git a/exampleSite/content/docs/shortcodes/index.ja.md b/exampleSite/content/docs/shortcodes/index.ja.md index 6cb83f3e..0bf5722e 100644 --- a/exampleSite/content/docs/shortcodes/index.ja.md +++ b/exampleSite/content/docs/shortcodes/index.ja.md @@ -72,16 +72,17 @@ Twitter で私を[フォロー](https://twitter.com/nunocoracao)するのを忘 | パラメータ | 説明 | | --------- | -------------------------------------------------------- | | `link` | **必須** ターゲット記事への `.RelPermalink`。 | -| `showSummary` | **任意。** 記事の要約を表示するかどうかを示すブール値。設定されていない場合、サイトのデフォルト設定が使用されます。 | +| `showSummary` | **オプション** のブール値で、記事の要約を表示するかどうかを示します。設定されていない場合は、サイトのデフォルト設定が使用されます。 | +| `compactSummary` | **オプション** のブール値で、要約をコンパクトモードで表示するかどうかを示します。デフォルトは false です。 | **例:** ```md -{{}} +{{}} ``` -{{< article link="/docs/welcome/" >}} +{{< article link="/ja/docs/welcome/" showSummary=true compactSummary=true >}}


diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md index 052a2e81..4ec2be3a 100644 --- a/exampleSite/content/docs/shortcodes/index.md +++ b/exampleSite/content/docs/shortcodes/index.md @@ -73,16 +73,16 @@ This is an error! | --------- | -------------------------------------------------------- | | `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. | - +| `compactSummary` | **Optional.** A boolean value indicating whether to display the summary in compact mode. Default to false. | **Example:** ```md -{{}} +{{}} ``` -{{< article link="/docs/welcome/" >}} +{{< article link="/docs/welcome/" showSummary=true compactSummary=true >}}


diff --git a/exampleSite/content/docs/shortcodes/index.zh-cn.md b/exampleSite/content/docs/shortcodes/index.zh-cn.md index acd32b4a..91ec4cf5 100644 --- a/exampleSite/content/docs/shortcodes/index.zh-cn.md +++ b/exampleSite/content/docs/shortcodes/index.zh-cn.md @@ -72,17 +72,17 @@ This is an error! | 参数 | 功能 | | ------ | ------------------------------------- | | `link` | **必填** 要嵌入文章的 `.RelPermalink` | -| `showSummary` | **可选。** 一个布尔值,指示是否显示文章摘要。如果未设置,将使用站点的默认配置。 | - +| `showSummary` | **可选** 布尔值,指示是否显示文章摘要。如果未设置,将使用站点的默认配置。 | +| `compactSummary` | **可选** 布尔值,指示是否以紧凑模式显示摘要。默认为 false。 | **例如:** ```md -{{}} +{{}} ``` -{{< article link="/zh-cn/docs/welcome/" >}} +{{< article link="/zh-cn/docs/welcome/" showSummary=true compactSummary=true >}}