Icon
Standalone icon display supporting Font Awesome, Lucide, and other icon libraries.
For isolated previews, theme switching, and sandbox editing, open the Icon 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.
Basic
Default icon display.
mdx<Icon name="star" />
Sized
Larger icon with custom size.
mdx<Icon name="rocket" size="32" />
Colored
Icon with a custom color.
mdx<Icon name="heart" size="24" color="#ef4444" />
Props
| Prop | Type | Default | Description |
|---|---|---|---|
name | string | star | Icon name from the icon library. |
size | string | 20 | Icon size in pixels. |
color | string | -- | CSS color value for the icon. |
library | string | lucide | Icon library. Uses the project default when omitted. |
Usage
Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.
mdx<Icon name="star" />
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: Icon on holydocs.com
- Component library index: /components