Index

mkdocs_terok

Shared MkDocs documentation generators for terok projects.

Provides reusable modules for CI maps, test maps, quality reports, API reference pages, and Pydantic config reference rendering. The terok MkDocs plugin wraps all generators; individual modules remain usable standalone (they never import mkdocs themselves).

brand_css_path()

Return the filesystem path to the shared brand CSS file.

Source code in src/mkdocs_terok/__init__.py

def brand_css_path() -> Path:
    """Return the filesystem path to the shared brand CSS file."""
    return Path(__file__).parent / "_assets" / "extra.css"

mermaid_zoom_js_path()

Return the filesystem path to the Mermaid diagram zoom script.

Source code in src/mkdocs_terok/__init__.py

def mermaid_zoom_js_path() -> Path:
    """Return the filesystem path to the Mermaid diagram zoom script."""
    return Path(__file__).parent / "_assets" / "mermaid_zoom.js"