Skip to content

Map doxygen tags to github syntax #126

Description

@gkodinov

Currently moxygen maps e.g. the @note syntax to Pandoc's :::note syntax.

With the prevalence of github Markdown syntax (https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) there is a better mapping that's understood by more tools and github itself: Alerts (https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts).

This is a suggestion to implement a special moxygen (command line?) mode that will output github specific extensions, e.g.

@note
This is a note

Could become

> [!NOTE]
> This is a note

Which will result in

Note

This is a note

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions