gdtest_icon_shortcode — Synthetic Package Details

#273 gdtest_icon_shortcode OK INIT

Icon shortcode in headings, tables, callouts, and prose

Two user-guide pages exercising the Lucide icon Quarto shortcode in many content contexts: section headings, inline prose, Markdown tables, callouts (note, tip, warning), ordered and unordered lists, blockquotes, and definition lists. A second page provides an icon gallery with navigation, status, and file/code icon groups plus a size comparison. Tests that the shortcode bridge produces inline SVG elements with the correct Lucide path data, custom sizes, and accessible labels.

View Site → Build Log 🧪 Test Coverage

Build Mode

○ No great-docs.yml

This package has no pre-supplied config. It tests the full great-docs init → great-docs build pipeline from scratch, relying entirely on auto-detection of the package layout, docstring style, and exports.

Dimensions

A1 B1 C4 D2 E6 F1 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C4Mixed class+funcobjects

D2Googledocstrings

E6No directivesdirectives

F1Auto-discoveruser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_icon_shortcode/

📄 __init__.py

"""Icon shortcode demo package."""

__version__ = "1.0.0"
__all__ = ["render", "transform"]


def render(template: str) -> str:
    """Render a template string.

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

    Returns
    -------
    str
        Rendered output.
    """
    return template


def transform(data: list) -> list:
    """Transform a data list.

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

    Returns
    -------
    list
        Transformed data.
    """
    return data

📁 user_guide/

📄 01-icon-showcase.qmd

---
title: 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.

📄 02-icon-gallery.qmd

---
title: 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" >}}

📄 README.md

# gdtest-icon-shortcode

A synthetic test package that exercises the `{{< icon >}}` Quarto
shortcode in many different content contexts: headings, tables,
callouts, lists, blockquotes, and definition lists.

📄 great-docs.yml generated

# Great Docs Configuration
# See https://posit-dev.github.io/great-docs/user-guide/configuration.html

# Module Name (optional)
# ----------------------
# Set this if your importable module name differs from the project name.
# Example: project 'py-yaml12' with module name 'yaml12'
# module: yaml12

# Docstring Parser
# ----------------
# The docstring format used in your package (numpy, google, or sphinx)
parser: numpy

# Dynamic Introspection
# ---------------------
# Use runtime introspection for more accurate documentation (default: true)
# Set to false if your package has cyclic alias issues (e.g., PyO3/Rust bindings)
dynamic: true

# API Discovery Settings
# ----------------------
# Exclude items from auto-documentation
# exclude:
#   - InternalClass
#   - helper_function

# Logo & Favicon
# ---------------
# Point to a single logo file (replaces the text title in the navbar):
# logo: assets/logo.svg
#
# For light/dark variants:
# logo:
#   light: assets/logo-light.svg
#   dark: assets/logo-dark.svg
#
# To show the text title alongside the logo, add: show_title: true

# Funding / Copyright Holder
# --------------------------
# Credit the organization that funds or holds copyright for this package.
# Displays in sidebar and footer. Homepage and ROR provide links.
# funding:
#   name: "Posit Software, PBC"
#   roles:
#     - Copyright holder
#     - funder
#   homepage: https://posit.co
#   ror: https://ror.org/03wc8by49

# API Reference Structure
# -----------------------
# Customize the sections below to organize your API documentation.
# - Reorder items within a section to change their display order
# - Move items between sections or create new sections
# - Use 'members: false' to exclude methods from documentation
# - Add 'desc:' to sections for descriptions

reference:
  - title: Functions
    desc: Utility functions
    contents:
      - render
      - transform

# Site URL
# --------
# Canonical address of the deployed documentation site.
# Required for subdirectory deployments, skills page install commands,
# .well-known/ discovery, and sitemaps.
# site_url: "https://your-org.github.io/your-package/"

# Site Settings
# -------------
# site:
#   theme: flatly              # Quarto theme (default: flatly)
#   toc: true                  # Show table of contents (default: true)
#   toc-depth: 2               # TOC heading depth (default: 2)
#   toc-title: On this page    # TOC title (default: "On this page")

# Jupyter Kernel
# --------------
# Jupyter kernel to use for executing code cells in .qmd files.
# This is set at the project level so it applies to all pages, including
# auto-generated API reference pages. Can be overridden in individual .qmd
# file frontmatter if needed for special cases.
jupyter: python3

# CLI Documentation
# -----------------
# cli:
#   enabled: true              # Enable CLI documentation
#   module: my_package.cli     # Module containing Click commands
#   name: cli                  # Name of the Click command object