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
- Build or view the documentation site with MkDocs Material.
- Open a package page that contains Markdown inside a raw HTML container, such as a collapsible details section, centered footer, or feature table.
- 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
Package
Documentation
Description
Several documentation pages use raw HTML containers such as
<details>,<div align="center">, and table cells around Markdown content. Without an explicitmarkdownmode supported by themd_in_htmlextension, 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
Environment
Documentation site built from this repository using MkDocs Material and the configured
md_in_htmlMarkdown extension.Logs / Error Output
N/A — this is a rendering defect with no runtime error output.
Code of Conduct