# Reference URL: https://lbliii.github.io/chirp-ui/docs/reference/ Section: reference -------------------------------------------------------------------------------- The chirp-theme ships a small authoring vocabulary on top of Markdown: inline shortcodes ({{ }}) for media, callouts, and live component specimens, and block directives (:::{name}) for admonitions and card grids. Everything here renders with Chirp UI markup, so authored content matches the rest of the site. You do not need to leave this site to learn the vocabulary — every shortcode and directive below has its parameters and a rendered example on the page. In this section Code Shortcodes Inline {{</* name */>}} helpers — component_specimen, the tip / warning / danger callout family, figure / gallery / img / audio media, details, highlight, blockquote, and the ref / relref / param link helpers. Directives Block :::{name} containers — admonition for the full semantic callout family, plus card, cards, and child_cards for card grids that mirror the component vocabulary. When to reach for what You want to… Use Show a live, rendered Chirp UI component inside prose {{ }} shortcode Call out a tip, warning, or danger inline {{ }} / {{ }} / {{ }} shortcodes Author any semantic admonition (note, hint, caution, …) as a block :::{admonition} directive Embed an image with a caption {{ }} shortcode Lay out several images in a grid {{ }} wrapping {{ }} Link to another page by source path (resolved at build) {{ }} / {{ }} shortcodes Echo a config or front-matter value into prose {{ }} shortcode Group several linked cards :::{cards} + :::{card} directives Looking for the components themselves? Browse the component catalog for every public macro with options and live examples. -------------------------------------------------------------------------------- Metadata: - Word Count: 265 - Reading Time: 1 minutes