Skip to content

docs: fix MDX parse errors from bare {…} expressions in concepts pages#28866

Open
kapunahelewong wants to merge 1 commit intobazelbuild:masterfrom
kapunahelewong:escape-fixes
Open

docs: fix MDX parse errors from bare {…} expressions in concepts pages#28866
kapunahelewong wants to merge 1 commit intobazelbuild:masterfrom
kapunahelewong:escape-fixes

Conversation

@kapunahelewong
Copy link
Copy Markdown
Contributor

@kapunahelewong kapunahelewong commented Mar 3, 2026

Description

Fix MDX parse errors in docs/concepts/labels.mdx, docs/concepts/build-files.mdx, and docs/concepts/dependencies.mdx caused by bare {…} expressions that MDX tries to interpret as JSX.

Changes:

  • Replace template syntax ({{ "<var>" }} / {{ "</var>" }}) with plain HTML <var>/</var> elements
  • Remove {: .external} link attribute from build-files.mdx
  • Escape bare { in <pre> code blocks in dependencies.mdx

Motivation

These three files fail MDX parsing in the Bazel docs site (bazel-contrib/bazel-docs). The double-curly {{ }} patterns are template syntax that need to be removed for the .md.mdx migration, and MDX's JSX parser rejects them as invalid expressions.

Per conversation in bazel-contrib/bazel-docs#181

Build API Changes

No

Checklist

  • I have added tests for the new use cases (if any).
  • I have updated the documentation (if applicable).

Release Notes

RELNOTES: None

Depends on: bazel-contrib/bazel-docs#206

@github-actions github-actions bot added the awaiting-review PR is awaiting review from an assigned reviewer label Mar 3, 2026
@kapunahelewong kapunahelewong marked this pull request as draft March 3, 2026 17:53
@iancha1992 iancha1992 added team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website team-Documentation Documentation improvements that cannot be directly linked to other team labels labels Mar 4, 2026
@kapunahelewong kapunahelewong marked this pull request as ready for review April 11, 2026 02:08
kapunahelewong added a commit to kapunahelewong/bazel-docs that referenced this pull request Apr 11, 2026
build-files.mdx, dependencies.mdx, and labels.mdx had bare {..} MDX
parse errors that are fixed upstream. Remove them from .mintignore so
they are rendered and included in navigation.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting-review PR is awaiting review from an assigned reviewer team-Documentation Documentation improvements that cannot be directly linked to other team labels team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants