Button Base

button_base renders one button-style element using the shared button macro. Use it for inline actions inside documentation pages, compact CTAs, or custom Markdown sections.

When to Use

Use button_base when you need one action and do not need a full CTA section. It can render as an <a> when href is provided or as a button-style element when it is not.

Usage

{{ button_base(
text="Open documentation",
href="/docs/",
variant="solid",
color="neutral",
icon_right="arrow-right"
) }}

Live Example

Open documentation

Parameters

ParameterDescription
textButton label. Required.
hrefOptional URL. When present, the shortcode renders a link.
targetOptional link target, such as _blank.
variantVisual style: solid, outline, or ghost.
colorSemantic color: neutral, info, success, warning, or error.
sizeButton size: sm, md, or lg.
iconOptional icon rendered before the label.
icon_rightOptional icon rendered after the label.
radiusBorder radius: sm, md, lg, or full.
wideSet to true to make the button full width.
disabledSet to true to disable interaction.
typeButton type when no href is provided. Defaults to button.
classAdditional CSS classes appended to the rendered element.