----------------------------------------------------------------------
This is the API documentation for the gdtest_icon_shortcode library.
----------------------------------------------------------------------


## Functions

Utility functions


render(template: str) -> str

Render a template string.

Parameters
----------
template
    The template to render.

Returns
-------
str
    Rendered output.

transform(data: list) -> list

Transform a data list.

Parameters
----------
data
    Input data.

Returns
-------
list
    Transformed data.


----------------------------------------------------------------------
This is the User Guide documentation for the package.
----------------------------------------------------------------------

### Icon Showcase

This page exercises the `{{< icon >}}` shortcode in many
different content contexts.

## {{< icon rocket >}} Headings with Icons

Icons can appear in section headings to give visual cues.

### {{< icon settings >}} Sub-heading Example

A sub-heading with an icon too.

## Inline Prose

You can place icons inline: {{< icon heart >}} for love,
{{< icon star >}} for favorites, and {{< icon check >}} for
completion.

## Icons with Options

A larger icon: {{< icon rocket size="24" >}} renders at 24px.

An accessible icon: {{< icon alert-triangle label="Warning" >}}
has an aria-label instead of aria-hidden.

## {{< icon table >}} Tables

Icons work inside table cells:

| Feature | Status | Icon |
|---------|--------|------|
| Rendering | Complete | {{< icon check >}} |
| Search | In Progress | {{< icon loader >}} |
| Export | Planned | {{< icon calendar >}} |

## {{< icon message-square >}} Callouts

:::{.callout-note}
## {{< icon info >}} Note with Icon
This callout has an icon in its title.
:::

:::{.callout-tip}
## {{< icon lightbulb >}} Tip
Use `{{< icon name >}}` to insert any of the 1900+ Lucide icons.
:::

:::{.callout-warning}
## {{< icon alert-triangle >}} Warning
Some icons may not render if the name is misspelled.
:::

## {{< icon list >}} Lists

Unordered list with icons:

- {{< icon file-text >}} Documentation
- {{< icon code-2 >}} Source code
- {{< icon test-tube >}} Testing
- {{< icon package >}} Packaging

Ordered list:

1. {{< icon download >}} Install the package
2. {{< icon settings >}} Configure your project
3. {{< icon play >}} Run the build

## {{< icon quote >}} Blockquotes

> {{< icon message-circle >}} Icons render inside blockquotes too.
> This is useful for attributions and callouts.

## {{< icon book-open >}} Definition Lists

{{< icon heart >}} Heart
:   Represents love or favorites.

{{< icon star >}} Star
:   Represents ratings or bookmarks.

{{< icon zap >}} Zap
:   Represents speed or energy.


### Icon Gallery

A gallery of commonly used icons for quick reference.

## Navigation Icons

| Icon | Name |
|------|------|
| {{< icon home >}} | home |
| {{< icon menu >}} | menu |
| {{< icon search >}} | search |
| {{< icon arrow-left >}} | arrow-left |
| {{< icon arrow-right >}} | arrow-right |
| {{< icon external-link >}} | external-link |

## Status Icons

| Icon | Name | Meaning |
|------|------|---------|
| {{< icon check-circle >}} | check-circle | Success |
| {{< icon x-circle >}} | x-circle | Error |
| {{< icon alert-circle >}} | alert-circle | Warning |
| {{< icon info >}} | info | Information |
| {{< icon help-circle >}} | help-circle | Help |

## File & Code Icons

| Icon | Name |
|------|------|
| {{< icon file >}} | file |
| {{< icon folder >}} | folder |
| {{< icon code-2 >}} | code-2 |
| {{< icon terminal >}} | terminal |
| {{< icon git-branch >}} | git-branch |
| {{< icon git-commit-horizontal >}} | git-commit-horizontal |

## Sized Icons

Icons at different sizes:

- 12px: {{< icon star size="12" >}}
- 16px: {{< icon star size="16" >}} (default)
- 20px: {{< icon star size="20" >}}
- 24px: {{< icon star size="24" >}}
- 32px: {{< icon star size="32" >}}