Skip to content

Fix flag name rendering in versioned pages#29408

Open
nikki-ef wants to merge 1 commit intobazelbuild:masterfrom
nikki-ef:docs-fix-flag-rendering-emdash
Open

Fix flag name rendering in versioned pages#29408
nikki-ef wants to merge 1 commit intobazelbuild:masterfrom
nikki-ef:docs-fix-flag-rendering-emdash

Conversation

@nikki-ef
Copy link
Copy Markdown
Contributor

@nikki-ef nikki-ef commented Apr 27, 2026

Description

Follow up to #29325

  • Wrapped flag names in single backticks to fix rendering issue where like --verbose on the flag cheatsheet are rendered with an emdash (—) instead of double dashes (--) due to Mintlify's smart typography converting -- in prose contexts
  • Hyperlinks to the command-line reference are preserved
  • This PR targets the flag cheatsheet page in versioned docs whereas fix: replace HTML flag headers with markdown to prevent emdash rendering #29325 fixed the issue in HEAD
  • Mintlify preview link coming soon...

Motivation

Fixes bazel-contrib/bazel-docs#366

Build API Changes

No

Checklist

  • Verify on Mintlify preview that flag names render with -- (not —)
  • Verify flag names are still clickable links to the command-line reference

Release Notes

N/A

RELNOTES: None

@github-actions github-actions Bot added the awaiting-review PR is awaiting review from an assigned reviewer label Apr 27, 2026
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Flag cheatsheet: -- rendered as emdash

1 participant