search

jothepro / doxygen-awesome-css

Custom CSS theme for doxygen html-documentation with lots of customization parameters.
https://jothepro.github.io/doxygen-awesome-css/
MIT License
1k stars 117 forks source link

[REQUEST] Add GitHub markdown admonitions styling #152

Closed ReenigneArcher closed 1 month ago

ReenigneArcher commented 1 month ago

Could you add support for GitHub markdown admonitions? https://github.com/orgs/community/discussions/16925

This would allow using admonitions in a readme file that will look nice in both GitHub and generated docs.

Current you get something like the following.

GitHub: image

Doxygen: image

Using something like @warning in markdown is a little weird, because that's a mention on GitHub.

ReenigneArcher commented 1 month ago

As I use doxygen and this theme more, I have a better understanding of why this, likely, won't be implemented... so closing.

Also, made some improvements to admonitions here: https://github.com/jothepro/doxygen-awesome-css/discussions/155

ReenigneArcher commented 1 month ago

Apparently this is supported by Doxygen now: https://www.doxygen.nl/manual/markdown.html#mddox_github_alerts