dbrun/blowfish
1
0
Fork 0
mirror of https://github.com/nunocoracao/blowfish.git synced 2026-01-30 15:31:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: document compactSummary option in article shortcode

Browse Source
This commit is contained in:
ZhenShuo Leo
2025-07-01 00:41:29 +08:00
parent b4a7741b39
commit ad1ba9905d
4 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
exampleSite/content/docs/shortcodes/index.md
+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/>