Skip to content

[Bug]: Render Markdown inside raw HTML on package documentation pages #4062

Description

Package

Documentation

Description

Several documentation pages use raw HTML containers such as <details>, <div align="center">, and table cells around Markdown content. Without an explicit markdown mode supported by the md_in_html extension, headings, links, lists, and emphasis display as literal Markdown in the generated site. The package pages in the Packages navigation need a consistent correction, along with the matching documentation pages affected by the same rendering rule.

How does this impact your work?

Readers see unrendered Markdown in package navigation pages and related documentation, which makes the published site harder to read and navigate. A source-level workaround is not appropriate because this needs a consistent docs-site fix.

Timeline

No hard deadline.

Steps to Reproduce

  1. Build or view the documentation site with MkDocs Material.
  2. Open a package page that contains Markdown inside a raw HTML container, such as a collapsible details section, centered footer, or feature table.
  3. Observe that the Markdown syntax is displayed instead of being rendered.

Environment

Documentation site built from this repository using MkDocs Material and the configured md_in_html Markdown extension.

Logs / Error Output

N/A — this is a rendering defect with no runtime error output.

Code of Conduct

  • I agree to follow the Microsoft Open Source Code of Conduct

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationtriageNeeds triage

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions