Skip to content

fix(mdx): stop double-escaping angle brackets inside code #1243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nlimpid wants to merge 1 commit into from
Closed

fix(mdx): stop double-escaping angle brackets inside code #1243

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions astro.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,21 @@ export default defineConfig({
/<CliCommand>\r?\n([\s\S]*?)\r?\n[ \t]*<\/CliCommand>/g,
(_m, inner: string) => `<CliCommand code={${JSON.stringify(inner)}} />`,
)
// 1.6) Stash every code region: fenced blocks, inline spans, and the
// CliCommand payload built just above. Their contents are literal
// text that shiki escapes on its own, so the rewrites below must
// not run over them — rule 5 turning `<iostream>` into `&lt;…&gt;`
// gets escaped a second time downstream and the page renders the
// entity text instead of the angle brackets. Fences are taken
// before inline spans so a fence's own backticks are never read as
// a span, and the CliCommand payload before both since it is a
// JSON string that may itself contain backticks.
const codeRegions: string[] = []
const stashCode = (m: string) => `\uE000CODE${codeRegions.push(m) - 1}\uE000`
out = out
.replace(/<CliCommand code=\{"(?:[^"\\]|\\.)*"\} \/>/g, stashCode)
.replace(/^[ \t]*(`{3,}|~{3,})[^\n]*\n[\s\S]*?^[ \t]*\1[ \t]*$/gm, stashCode)
.replace(/`[^`\n]+`/g, stashCode)
// 2) Convert vitepress heading anchor syntax `## Foo {#bar}` →
// `<h2 id="bar">Foo<a …/></h2>`.
// MDX parses `{#bar}` as a JSX expression (acorn) before remark plugins run,
Expand Down Expand Up @@ -147,6 +162,10 @@ export default defineConfig({
/^(:{3,})(success|warning|tip|info|danger|note|caution)([ \t]+)([^\n[\]{]+?)\s*$/gm,
(_match, colons, name, _ws, title) => `${colons}${name}[${title.trim()}]`,
)
// Put back the code regions stashed in 1.6, now that every rewrite
// above has run. Indices come from our own placeholders, so the
// fallback is unreachable; it only keeps the lookup total.
out = out.replace(/\uE000CODE(\d+)\uE000/g, (_m, i) => codeRegions[Number(i)] ?? '')
return out === code ? null : { code: out, map: null }
},
},
Expand Down
Loading