## Documentation index

This index lists every available documentation page and its Markdown source.

- [Documentation](https://vara.varavel.com/docs/index.md)
  - [Introduction](https://vara.varavel.com/docs/introduction/index.md)
  - [Getting Started](https://vara.varavel.com/docs/getting-started/index.md)
    - [Installation](https://vara.varavel.com/docs/getting-started/installation/index.md)
    - [Quick Start](https://vara.varavel.com/docs/getting-started/quick-start/index.md)
    - [Composing a Landing Page](https://vara.varavel.com/docs/getting-started/composing-landing-page/index.md)
  - [Fundamentals](https://vara.varavel.com/docs/fundamentals/index.md)
    - [Project Structure](https://vara.varavel.com/docs/fundamentals/project-structure/index.md)
    - [Page Generators](https://vara.varavel.com/docs/fundamentals/page-generators/index.md)
    - [Site Settings](https://vara.varavel.com/docs/fundamentals/site-settings/index.md)
    - [Search and LLM Output](https://vara.varavel.com/docs/fundamentals/search-and-llms/index.md)
    - [Customization](https://vara.varavel.com/docs/fundamentals/customization/index.md)
    - [Functions and Filters](https://vara.varavel.com/docs/fundamentals/functions-and-filters/index.md)
  - [Templates](https://vara.varavel.com/docs/templates/index.md)
    - [vara-landing](https://vara.varavel.com/docs/templates/landing/index.md)
    - [vara-docs](https://vara.varavel.com/docs/templates/docs/index.md)
    - [vara-docs-raw](https://vara.varavel.com/docs/templates/docs-raw/index.md)
    - [vara-docs-search-index](https://vara.varavel.com/docs/templates/docs-search-index/index.md)
    - [vara-docs-llms-txt](https://vara.varavel.com/docs/templates/docs-llms-txt/index.md)
    - [vara-docs-llms-full-txt](https://vara.varavel.com/docs/templates/docs-llms-full-txt/index.md)
    - [vara-sitemap-xml](https://vara.varavel.com/docs/templates/sitemap-xml/index.md)
    - [vara-404](https://vara.varavel.com/docs/templates/404/index.md)
  - [Components](https://vara.varavel.com/docs/components/index.md)
    - [Alert](https://vara.varavel.com/docs/components/alert/index.md)
    - [Badge](https://vara.varavel.com/docs/components/badge/index.md)
    - [Button](https://vara.varavel.com/docs/components/button/index.md)
    - [Container](https://vara.varavel.com/docs/components/container/index.md)
    - [Icon](https://vara.varavel.com/docs/components/icon/index.md)
    - [Keyboard Key](https://vara.varavel.com/docs/components/kbd/index.md)
    - [Header](https://vara.varavel.com/docs/components/header/index.md)
    - [Hero](https://vara.varavel.com/docs/components/hero/index.md)
    - [Content Split](https://vara.varavel.com/docs/components/content-split/index.md)
    - [Features](https://vara.varavel.com/docs/components/features/index.md)
    - [Stats](https://vara.varavel.com/docs/components/stats/index.md)
    - [FAQ](https://vara.varavel.com/docs/components/faq/index.md)
    - [Testimonial](https://vara.varavel.com/docs/components/testimonial/index.md)
    - [Carousel](https://vara.varavel.com/docs/components/carousel/index.md)
    - [Call to Action](https://vara.varavel.com/docs/components/cta/index.md)
    - [Footer](https://vara.varavel.com/docs/components/footer/index.md)
  - [Troubleshooting](https://vara.varavel.com/docs/troubleshooting/index.md)


## Documentation content

The documentation for the current page follows, reproduced verbatim.


# Icon

`<vara-icon>` renders an optimized SVG from Vara's icon bundle. Icons are decorative by default; provide `label` only when the icon carries meaning without adjacent text.

## Usage

```html
<vara-icon name="rocket" label="Deployment" class="size-6 text-info" />
```

## Preview

<vara-icon name="rocket" label="Deployment" class="size-8 text-info" />
<vara-icon name="github" label="GitHub" class="size-8" />
<vara-icon name="circle-check" label="Complete" class="size-8 text-success" />

## Props

| Prop    | Type   | Default | Description                                       |
| ------- | ------ | ------- | ------------------------------------------------- |
| `name`  | string | `""`    | Bundled icon filename without `.svg`.             |
| `label` | string | `""`    | Accessible name for a meaningful standalone icon. |
| `class` | string | `""`    | Size, color, and positioning utilities.           |

## Accessibility

Decorative SVGs are hidden from assistive technology and cannot receive focus. When an icon carries meaning on its own, add a `label` so screen readers announce it.

## Brand icons

The bundle includes both Lucide icons and Simple Icons brand marks. When a name exists in both sets, the brand version is prefixed with `si-`:

```html
<vara-icon name="si-github" class="size-8" />
<vara-icon name="si-tailwindcss" class="size-8" />
```

## Where to find icon names

The bundle follows the Lucide and Simple Icons catalogs, and this site ships a searchable explorer of every bundled icon:

- [Browse the icon explorer](/icons/)

Use the name as shown in the explorer. Remember to prefix a brand icon with `si-` when it shares a name with a Lucide icon.

## Missing icons

If an icon is missing, Vara renders a visible error glyph instead of failing the build, so a typo never breaks your site.