docs: document compactSummary option in article shortcode

This commit is contained in:
ZhenShuo Leo committed 2025-07-13 18:44:45 +08:00
1 parent b4a7741b39
commit ad1ba9905d
4 files changed
+14 -12

No files matched your search

+3 -3
View File
@@ -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. |
<!-- prettier-ignore-end -->
**Example:**
```md
{{</* article link="/docs/welcome/" */>}}
{{</* article link="/docs/welcome/" showSummary=true compactSummary=true */>}}
```
{{< article link="/docs/welcome/" >}}
{{< article link="/docs/welcome/" showSummary=true compactSummary=true >}}
<br/><br/><br/>