Fix titled admonitions rendering as literal text - #7
Merged
Merged
Conversation
The faster build pipeline (future.v4 + @docusaurus/faster) uses the Rust mdx-rs parser, which only accepts the canonical `:::type[Title]` directive label form. The legacy space-separated `:::type Title` form silently fell through as a literal paragraph, so every titled admonition rendered as raw `:::` text on docs.neatcontext.com. Convert all 17 titled admonitions to the bracket form so they render as callout boxes under both parsers. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Problem
Every titled admonition (
:::tip Title,:::info Title, …) renders as raw:::text on docs.neatcontext.com instead of a styled callout box. Confirmed against the live HTML: on the intro page the title-less:::noterenders correctly while:::tip Quick hands-on demofalls through as a literal<p>:::tip …</p>.Root cause
The site enables the faster build pipeline (
future.v4: true+@docusaurus/faster), which uses the Rustmdx-rsMDX parser. That parser only accepts the canonical directive-label form:::type[Title]. The legacy space-separated:::type Titleform isn't recognized, so the directive silently fails to parse and is emitted as a literal paragraph. Title-less admonitions parse fine in both parsers, which is why the lone:::notestill worked.Fix
Convert all 17 titled admonitions across the docs to the bracket form, e.g.
:::tip Quick hands-on demo→:::tip[Quick hands-on demo]. This is spec-correct and renders under both parsers.Verification
npm run buildsucceeds.:::occurrences and propertheme-admonitionboxes on the affected pages (intro, getting-started, and the rest).🤖 Generated with Claude Code