Skip to content

Commit 0c0867b

Browse files
committed
Cards: Updated card params in example site
1 parent 6db30ba commit 0c0867b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

exampleSite/content/test-product/cards/permitted.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,27 @@ and will render as the following:
2929
### Params
3030
To support customization, there are also some params you can add to the shortcode `<card>` such as `title`, `titleUrl`, `icon`, `brandIcon`, `isFeaturedCard`, `isFullSize`.
3131

32-
* `title` - Title of the card.
32+
* `title` (required) - Title of the card.
3333
<br>
34-
* `titleUrl` - URL for the card.
34+
* `titleUrl` (optional) - URL for the card.
3535
<br>
36-
* `icon` - Custom icon using <a href="https://lucide.dev/icons/">lucide</a> icons.
36+
* `icon` (optional) - Custom icon using <a href="https://lucide.dev/icons/">lucide</a> icons.
3737
<br>
38-
* `brandIcon` - Custom icon using image from `nginx-hugo-theme/static/images/icons`.
38+
* `brandIcon` (optional) - Custom icon using image from `nginx-hugo-theme/static/images/icons`.
3939
* Usage: `<card brandIcon="NGINX-App-Protect-WAF-product-icon"...>`
4040
<br>
41-
* `isFeaturedCard` - Boolean indicating whether or not the card should be the first one and full size. By default, false.
41+
* `isFeaturedCard` (optional) - Boolean indicating whether or not the card should be the first one and full size. By default, false.
4242
* Usage: `<card isFeaturedCard="true"...>`
4343
<br>
44-
* `isFullSize` - Boolean indicating whether or not the card should be full size. By default, cards are half sized.
44+
* `isFullSize` (optional) - Boolean indicating whether or not the card should be full size. By default, cards are half sized.
4545
* Usage: `<card isFullSize="true"...>`
4646

4747
For the `<card-section>`, there are some params you can add such as `title`, `isFeaturedSection`, and `showAsCards`.
4848
* `title` - Title of the section.
4949
<br>
50-
* `isFeaturedSection` - Boolean indicating whether or not the section is a featured one - will discuss later down the page. By default, false.
50+
* `isFeaturedSection` (optional) - Boolean indicating whether or not the section is a featured one - will discuss later down the page. By default, false.
5151
<br>
52-
* `showAsCards` - Boolean indicating whether or not the cards in the section should appear with borders. By default, false.
52+
* `showAsCards` (optional) - Boolean indicating whether or not the cards in the section should appear with borders. By default, false.
5353

5454
### Additional Information
5555
While it may come immediate, you can't use a `<card>` shortcode on its own in your markdown or else the build will fail. This is because if you call a card, there is no way to structure it in a writer-friendly customizable way.

0 commit comments

Comments
 (0)