Vitrinev1.0.4

Shortcodes

The shortcodes Vitrine adds, and their options.

example

Runs an example and shows its files. The example shortcode explains it.

md
{{< example "demo" >}}
{{< example name="demo" title="A title" run="true" code="true" frame="true" >}}
OptionDefault
name (or the only positional value)nonethe folder with example.html, style.css, script.js: next to the page, or in assets/examples/
titlenonea title in the frame’s label
runtruefalse: show only the files
codetruefalse: run without showing the files
frametruefalse: run bare, no frame and no files

tabs and tab

Content in variants, one shown at a time. Tabs and callouts has examples.

md
{{< tabs group="install" >}}
{{< tab "npm" >}}Markdown{{< /tab >}}
{{< tab "pnpm" >}}Markdown{{< /tab >}}
{{< /tabs >}}
OptionDefault
tabs: groupnonetab sets of the same group switch together, and the choice is remembered
tab: the positional valuenonethe tab’s label

callout

A note or a warning, in Markdown.

md
{{< callout >}}A note.{{< /callout >}}
{{< callout "warning" >}}A warning.{{< /callout >}}
OptionDefault
the positional valuenotenote or warning