systemausfall.org/hugo-theme-hilfe
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: use a propertylist to document shortcode attributes (#732)

Browse source
This commit is contained in:
Robert Kaussow 2023-10-27 21:38:23 +02:00 • committed by GitHub
parent 76ef8f147c
commit 83469c437f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 256 additions and 94 deletions
Download patch file Download diff file Expand all files Collapse all files

19
exampleSite/content/en/shortcodes/toc.md
View file

@ -4,21 +4,22 @@ title: ToC
Simple wrapper to generate a page Table of Content from a shortcode.
**Attributes:**
## Usage
| Name | Description | Default |
| ------ | -------------------------- | ------------------------------------------------------------- |
| format | format of the returned ToC | <!-- spellchecker-disable -->html<!-- spellchecker-enable --> |
**Usage:**
<!-- prettier-ignore-start -->
<!-- prettier-ignore -->
```tpl
{{</* toc (format=[html|raw]) */>}}
```
### Attributes
<!-- prettier-ignore-start -->
<!-- spellchecker-disable -->
{{< propertylist name=shortcode-toc sort=name order=asc >}}
<!-- spellchecker-enable -->
<!-- prettier-ignore-end -->
**Example:**
## Example
{{< toc >}}