Badge
Inline status labels for marking content with version info, stability, or other metadata.
For isolated previews, theme switching, and sandbox editing, open the Badge playground on holydocs.com .
When to use
Use this component when you need stronger document structure, annotation, or narrative pacing inside a page.
Live Examples
Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.
Default
Stable
mdx<Badge>Stable</Badge>
New
New
mdx<Badge variant="new">New</Badge>
Warning
Deprecated
mdx<Badge variant="warning">Deprecated</Badge>
Success
Passing
mdx<Badge variant="success">Passing</Badge>
Danger
Breaking
mdx<Badge variant="danger">Breaking</Badge>
Props
| Prop | Type | Default | Description |
|---|---|---|---|
variant | "default" | "new" | "warning" | "success" | "danger" | default | Color and semantic style of the badge. |
Usage
Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.
mdx<Badge>Stable</Badge>
Tips
- Keep the surrounding copy short so the component remains the focal point instead of becoming redundant chrome.
- Prefer one clear job per component instance. If a block is trying to explain, navigate, and warn at the same time, split it up.
- Check the page in both light and dark mode when you stack multiple content components together. Dense compositions can feel heavier than expected.
Related Components
Callout
Highlighted message blocks for drawing attention to notes, tips, warnings, and other contextual information.
More
- Interactive playground: Badge on holydocs.com
- Component library index: /components