Skip to content

Fix admonition titles rendering as literal text (83 on 48 pages) - #147

Merged
melvincarvalho merged 1 commit into
gh-pagesfrom
fix/admonition-titles
Oct 18, 2026
Merged

melvincarvalho merged 1 commit into
gh-pagesfrom
fix/admonition-titles

Conversation

@melvincarvalho

Copy link
Copy Markdown
Contributor

future.v4: true turns off markdown.mdx1Compat.admonitions. As a result, 83 admonitions on 48 pages written as :::danger Title showed the title as literal text, for example :::danger Commands run without asking by default on basic-usage. That includes the approval and sandbox safety warnings from #126.

This turns the compat flag back on. After the build, no HTML page contains a literal :::type Title line, and basic-usage renders the heading "Commands run without asking by default". The 1-line config change was chosen over rewriting 83 admonitions to :::type[Title]; the per-page conversion can follow later if we want to drop the compat flag.

Found by the security-timeline work in #146.

future.v4 turns off mdx1Compat.admonitions, so 83 admonitions on 48 pages
written as `:::danger Title` showed the title as literal text, including the
approval/sandbox safety warnings. Turn the compat flag back on; the build now
has no literal ':::' admonition lines.
@melvincarvalho
melvincarvalho merged commit e11be65 into gh-pages Oct 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant