gdtest-toc-disabled

Test site toc disabled config.

Tests site.toc: false. No table of contents should appear on any page. The layout should adjust to fill the space.

Source files

📁 gdtest_toc_disabled/

📄 __init__.py

"""Package testing site toc disabled config."""

__all__ = ["navigate", "bookmark"]


def navigate(path: str) -> str:
    """Navigate to the given path.

    Parameters
    ----------
    path : str
        The path to navigate to.

    Returns
    -------
    str
        The resolved navigation path.

    Examples
    --------
    >>> navigate("/home")
    '/home'
    """
    return path


def bookmark(page: str) -> int:
    """Bookmark a page and return the bookmark ID.

    Parameters
    ----------
    page : str
        The page to bookmark.

    Returns
    -------
    int
        The bookmark ID.

    Examples
    --------
    >>> bookmark("index")
    1
    """
    return 1

📄 README.md

# gdtest-toc-disabled

Test site toc disabled config.

📄 great-docs.yml

site:
  toc: false