Skip to content

GitHub markdown alerts do not work #11037

@samwarring

Description

@samwarring

Describe the bug
I'm trying to use GitHub alerts in markdown files (described here at the end of the page). No matter what I do, I cannot get [!note] blocks to render as \note.

Screenshots
The simple markdown page:

# Doxygen Test

Hello!

> [!note]
> This is a note, as a GitHub alert.

\note
This is a doxygen-native note.

is rendered as:

image

To Reproduce
The attached zip contains a default-generated Doxyfile and the README.md shown above. The only edit to the Doxyfile after generation was setting USED_MDFILE_AS_MAINPAGE = README.md.

Expected behavior
I expect both the GitHub alert and doxygen-native note to appear the same.

Version

$ doxygen --version
1.9.8

$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 24.04 LTS
Release:        24.04
Codename:       noble

(Ubuntu is running on Windows 11 via WSL)

Additional context
I've tried running Doxygen with the -d Markdown flag, and I'm finding that the > ![note] string is not being replaced with \note, but instead with <blockquote>&zwj;[!note]

Thank you in advance for your help!

Metadata

Metadata

Assignees

No one assigned

    Labels

    MarkdownMarkdown translation input related issueUsageThe mentioned problem is not a doxygen problem but due to usage of a feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions