Skip to content

Commit 8dbde18

Browse files
brand shortcode light/dark updates
(cherry picked from commit 1c279a0)
1 parent b422576 commit 8dbde18

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/authoring/brand.qmd

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -586,10 +586,13 @@ Beyond the automatic application of your brand file, you can also directly acces
586586

587587
Some values from the `_brand.yml` configuration file can be accessed via the `brand` shortcode. In particular, you can access colors and logos by name:
588588

589-
- Use `{{{< brand color COLOR_NAME BRAND_MODE >}}}` to return the brand color named `COLOR_NAME` as a string.
590-
- Use `{{{< brand logo LOGO_NAME BRAND_MODE >}}}` to return the brand logo named `LOGO_NAME` as an image.
589+
- Use `{{{< brand color COLOR_NAME VARIANT >}}}` to return the brand color named `COLOR_NAME` as a string.
590+
- Use `{{{< brand logo LOGO_NAME VARIANT >}}}` to return the brand logo named `LOGO_NAME` as an image.
591591

592-
The `BRAND_MODE` is optional and defaults to `light`. To return the color from the [dark brand](#dark-brand) use `dark`.
592+
`VARIANT` is optional:
593+
594+
- For the `brand color` shortcode, the default is `light`. To return the color from the [dark brand](#dark-brand) use `dark`.
595+
- For the `brand logo` shortcode, the default is `both`, which will add both light and dark logos with appropriate classes
593596

594597
For example, you could use the shortcode to place a brand image you've named `icon` in a dashboard sidebar:
595598

0 commit comments

Comments
 (0)