gdtest-hero-explicit-badges

A package with manually specified hero badges.

Features

Explicit badge list

Hero with an explicit badge list instead of auto-extraction. Tests that providing a list under hero.badges displays those explicit badges rather than extracting from the README.

Source files

📁 assets/

📄 logo.svg

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" width="32" height="32">
  <circle cx="16" cy="16" r="14" fill="#fd7e14"/>
</svg>

📁 gdtest_hero_explicit_badges/

📄 __init__.py

"""A package with explicit hero badges."""

__version__ = "0.2.0"
__all__ = ["parse"]


def parse(text: str) -> list:
    """
    Parse text into tokens.

    Parameters
    ----------
    text
        The text to parse.

    Returns
    -------
    list
        A list of tokens.
    """
    return text.split()

📄 README.md

# gdtest-hero-explicit-badges

[![README Badge](https://img.shields.io/badge/readme-badge-red)](https://example.com/readme)

A package with manually specified hero badges.

## Features

- Explicit badge list

📄 great-docs.yml

display_name: Explicit Badges
logo: assets/logo.svg
hero:
  badges:
    - alt: Custom Badge
      img: "https://img.shields.io/badge/custom-badge-purple"
      url: "https://example.com/custom"
    - alt: Status
      img: "https://img.shields.io/badge/status-stable-brightgreen"