Skip to content

Docs: Treat changelog as a markdown file #3531

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

Merged
adamziel merged 2 commits into from
Apr 27, 2026
+66 −136
Merged

Docs: Treat changelog as a markdown file #3531

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b44731
Docs: escape MDX braces when refreshing the changelog
adamziel Apr 27, 2026
756bc8f
Docs: parse changelog as plain Markdown, not MDX
adamziel Apr 27, 2026
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
9 changes: 8 additions & 1 deletion packages/docs/site/bin/refresh-changelog.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ const existingContent = fs.readFileSync(destinationPath, 'utf-8');
const frontmatterRegex = /^---\n([\s\S]*?)\n---/;
const existingFrontmatter = existingContent.match(frontmatterRegex)?.[0] || '';

const changelogWithFrontmatter = existingFrontmatter + '\n\n' + changelog;
// Docusaurus parses `.md` files as MDX, so unescaped `{...}` in PR titles
// (e.g. `@php-wasm/{web,node}-5-2`) gets evaluated as a JSX expression and
// crashes the build with "ReferenceError: web is not defined". Escape braces
// so they render as literal characters.
const mdxSafeChangelog = changelog.replace(/[{}]/g, '\\$&');

const changelogWithFrontmatter =
existingFrontmatter + '\n\n' + mdxSafeChangelog;

// Write the modified changelog to the destination file
fs.writeFileSync(destinationPath, changelogWithFrontmatter, 'utf-8');
Expand Down
Loading
Loading