← GDG /

#225 gdtest_hero_index_qmd

#225 gdtest_hero_index_qmd OK CONFIG
Hero section from index.qmd source file
Hero section from an index.qmd source file. Tests that hero generation works identically when the landing page source is index.qmd rather than README.md.
View Site → Build Log ๐Ÿงช Test Coverage

Build Mode

● Has great-docs.yml

This package ships a pre-supplied config. The great-docs init step is skipped and great-docs build uses the spec-defined configuration directly. Tests specific config options and their rendered output.

Dimensions

K13
K13funding configconfig

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="#6610f2"/>
</svg>
๐Ÿ“ gdtest_hero_index_qmd/
๐Ÿ“„ __init__.py
"""A package with an index.qmd landing page."""

__version__ = "0.1.0"
__all__ = ["compute"]


def compute(x: float, y: float) -> float:
    """
    Compute the sum of two values.

    Parameters
    ----------
    x
        First value.
    y
        Second value.

    Returns
    -------
    float
        The sum.
    """
    return x + y
๐Ÿ“„ great-docs.yml
display_name: Hero Index QMD
logo: assets/logo.svg
๐Ÿ“„ index.qmd
# gdtest-hero-index-qmd

[![PyPI](https://img.shields.io/badge/pypi-v0.1.0-blue)](https://pypi.org/p/gdtest-hero-index-qmd/)

A package with an index.qmd landing page.

## Overview

This tests that hero generation works from an index.qmd source.

## Features

- Custom index.qmd content
- Badge auto-extraction