Skip to content

Fix markdown formatting in dropdown titles#3640

Merged
lcawl merged 1 commit into
mainfrom
dropdown-titles
Jul 10, 2026
Merged

Fix markdown formatting in dropdown titles#3640
lcawl merged 1 commit into
mainfrom
dropdown-titles

Conversation

@lcawl

@lcawl lcawl commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Fixes #3637

Screenshots

Before

image

After

image

Summary

AdmonitionBlock.cs — after substitutions, dropdown titles are converted to plain text:

if (Admonition is "dropdown")
    Title = Title.StripMarkdown();

This uses the existing StripMarkdown() helper (Markdig ToPlainText). It applies to:

  • Hand-authored {dropdown} directives
  • Changelog-generated dropdowns (re-parsed through the normal directive pipeline)
  • CLI changelog render output on the next docs build

No changelog renderer changes.

Tests added

File Coverage
AdmonitionTests.cs Backticks, **bold**, _italic_ stripped from title and HTML
ChangelogDropdownsTests.cs ChangelogDropdownsPlainTextTitleTests — known-issue entry with `ElasticAgentVersion`

Docs updated

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: composer-2.5-fast

@lcawl lcawl marked this pull request as ready for review July 10, 2026 18:40
@lcawl lcawl requested review from a team as code owners July 10, 2026 18:40
@lcawl lcawl requested a review from technige July 10, 2026 18:40
@lcawl lcawl merged commit 95338ef into main Jul 10, 2026
25 checks passed
@lcawl lcawl deleted the dropdown-titles branch July 10, 2026 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request]: Handle code formatting in dropdowns

2 participants