Skip to content

Escape leading Markdown block markers in {{< ui >}} shortcode - #39970

Open
hestonhoffman wants to merge 1 commit into
masterfrom
heston/ui-shortcode-escape-block-markers
Open

hestonhoffman wants to merge 1 commit into
masterfrom
heston/ui-shortcode-escape-block-markers

Conversation

@hestonhoffman

@hestonhoffman hestonhoffman commented Sep 15, 2026

Copy link
Copy Markdown
Collaborator

What does this PR do? What is the motivation?

The {{< ui >}} shortcode pipes its label through markdownify. A label starting with +, -, *, #, or > was parsed as a list, heading, or blockquote instead of text, so it rendered mangled.

The shortcode now escapes the marker itself, and strips an escape an author already added, so + Add and \+ Add render the same. This also fixes several > Views labels that were broken but unreported.

Redundant \+ escapes are removed from content/en. Translated content is not edited and keeps working, because both forms are accepted.

Related to #39966, which fixes the same + issue at the call sites.

Preview links

Case Expected
sheets + renders as + (escape removed in this PR)
mcp_server/setup + renders as + (escape removed in this PR)
CI saved views > Views renders as text, not a blockquote (was broken)
RUM saved views > Views renders as text, not a blockquote (was broken)
metrics/advanced-filtering </> icon renders unchanged
logs pipelines </> icon renders unchanged
fr/sheets still has \+ in source, renders as +

Merge readiness

  • Ready for merge

AI assistance

Used Claude Code to identify the affected markers, update the shortcode, and remove the redundant escapes.

The ui shortcode pipes its label through markdownify, so a label starting
with +, -, *, #, or > was parsed as a list, heading, or blockquote instead
of text. The shortcode now escapes the marker itself and strips any escape
an author already added, so both "+ Add" and "\+ Add" render the same.

Removes the now-redundant escapes from content/en. Translated content keeps
working unedited because both forms are accepted.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@github-actions github-actions Bot added Architecture Everything related to the Doc backend Guide Content impacting a guide labels Sep 15, 2026
@hestonhoffman
hestonhoffman marked this pull request as ready for review September 15, 2026 20:11
@hestonhoffman
hestonhoffman requested review from a team as code owners September 15, 2026 20:11
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Possible site support note detected

The following files have a site-region shortcode at the top of the page that mentions a feature being "not available" or "not supported":

  • hugo/content/en/mcp_server/setup.md

Are you trying to document site support for a product? If so, the site-region shortcode is not the recommended approach. See the Documenting site support guide for the preferred method.

@github-actions

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@buraizu buraizu added the WORK IN PROGRESS No review needed, it's a wip ;) label Sep 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend Guide Content impacting a guide WORK IN PROGRESS No review needed, it's a wip ;)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants