Update documentation

This commit is contained in:
mark
2022-12-31 14:21:47 +01:00
parent 3945be2871
commit 840fbd42af

View File

@@ -113,21 +113,22 @@ Use the `card` shortcode to display a card that links to a content page. When us
|-------------|----------|-------------|
| path | Yes | Required path of the page. |
| class | No | Optional class attribute of the card element, e.g. “w-50”. |
| color" | No | Optional theme color of the card, either "primary", "secondary", "success", "danger", "warning", "info", "light", or "dark". By default, no color is specified. |
| color | No | Optional theme color of the card, either "primary", "secondary", "success", "danger", "warning", "info", "light", or "dark". By default, no color is specified. |
| padding | No | Optional padding of the content, either "0", "1", "2", "3", "4", "5", or "auto" (default). |
| header | No | Optional header components of the card, displayed in small caps. Supported values are "full" (default), "publication", "tags", and "none". |
| footer | No | Optional footer components of the card, displayed in small caps. Supported values are "full", "publication", "tags", and "none" (default). |
| orientation | No | Optional placecement of the thumbnail, either "stacked" (default), "horizontal", or "none". |
| layout | No | Optional layout of the card, either "rich" (default) or "minimal". |
{.table}
As an example, the following shortcode displays a colored, borderless horizontal card that links to the [Rich Content]({{< ref "rich-content" >}} "Rich Content") page.
As an example, the following shortcode displays a colored, borderless horizontal card that links to the [Rich Content]({{< ref "rich-content" >}} "Rich Content") page. It includes a custom header and footer.
```html
{{</* card path="rich-content" class="w-100 border-0" layout="rich" orientation="horizontal" color="info" */>}}
{{</* ccard path="rich-content" class="w-100 border-0" orientation="horizontal" color="info" header="publication" footer="tags */>}}
```
The result looks like this:
{{< card path="rich-content" class="w-100 border-0" layout="rich" orientation="horizontal" color="info" >}}
{{< card path="rich-content" class="w-100 border-0" orientation="horizontal" color="info" header="publication" footer="tags" >}}
## Carousel