fix: convert MkDocs admonitions to remark directives on 13 pages - #531
Open
prabhatsharma wants to merge 1 commit into
Open
fix: convert MkDocs admonitions to remark directives on 13 pages#531prabhatsharma wants to merge 1 commit into
prabhatsharma wants to merge 1 commit into
Conversation
Pages written after the MkDocs migration used the old admonition syntax (!!! note "Title" / ??? info "Title") that nothing in the Fumadocs pipeline processes, so 30 admonitions across 13 pages rendered as literal text with their indented bodies turned into code blocks. Converted to the site's directive syntax (:::note[Title] / :::warning[...] / :::accordion[...]), which lib/remark/mkdocs-directives.ts maps onto Callout and Details components — including the indented cases inside list items and the one collapsible. Verified in the built output: no literal markers remain, callouts and the accordion render, list flow around them is intact.
This was referenced Aug 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
30 admonitions across 13 pages still used the MkDocs syntax (
!!! note "Title"/??? info "Title"), which nothing in the Fumadocs pipeline processes — they rendered as literal!!!text with their indented bodies turned into code blocks. Found while building the SLO docs (#530).Converted to the site's existing directive syntax (
:::note[Title],:::warning[...],:::accordion[...]), whichlib/remark/mkdocs-directives.tsalready maps onto Callout / Details components. No new machinery.Affected: the 8 Mobile RUM pages, both pipeline guides, streams-in-openobserve (the one
???collapsible), organizations, and dashboard variables.Verified
pnpm buildclean, check-links passes.!!! type/??? typeremains anywhere.Conversion was scripted (fence-aware, preserves list indentation, dedents bodies); every diff eyeballed.