Skip to content

Koog MkDocs Material icons and nested content tabs are rendered as raw Markdown #48

Description

@2BAB

Description

Some Koog documentation pages render MkDocs Material syntax as plain text instead of rendering the intended UI components.

Examples:

  • The Koog overview displays icon macros such as :material-rocket-launch:{ .lg .middle } literally.
  • The quickstart displays content-tab markers such as === "OpenAI", nested platform tabs, and fenced code markers literally.

This is related to the general compatibility work tracked in #1 and #2, but it is a concrete Koog rendering bug. It is different from #39, which concerns translation output and Koog API versions.

Expected behavior

  • Material icon macros inside card grids should render as icons/cards.
  • Provider and platform tabs should render as tabbed content.
  • Nested fenced code blocks should render as normal highlighted code blocks.

Actual behavior

The MkDocs-specific syntax is visible as raw text on the rendered page.

Initial assessment

The synchronized files preserve the valid upstream Koog syntax, so this does not appear to be caused by translation.

Koog enables md_in_html, pymdownx.tabbed, and pymdownx.emoji in its MkDocs configuration. Open-Docs renders the synchronized content through VitePress and custom Markdown-It compatibility plugins. The current compatibility layer appears incomplete for these cases:

  • The code-tabs adapter handles tabs whose content begins with an indented fenced code block, but Koog uses outer content tabs containing prose and nested tabs.
  • The icon adapter uses a limited icon map and does not include the Koog overview icons such as material-rocket-launch, material-book-open-variant, and material-shield-check-outline.

Relevant sources

Screenshots

Image Image Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions