Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doxygen CSS #982

Merged
merged 1 commit into from
Jun 21, 2024
Merged

Update doxygen CSS #982

merged 1 commit into from
Jun 21, 2024

Conversation

2bndy5
Copy link
Member

@2bndy5 2bndy5 commented Jun 18, 2024

This also upgrades to doxygen to v1.11.0 which now supports github-style admonitions.

Basically, we can write the following in markdown:

> [!note]
> is translated to `\note`

> [!warning]
> is translated to `\warning`

> [!tip]
> is translated to `\remark`

> [!caution]
> is translated to `\attention`

> [!important]
> is translated to `\important`

and it will render in doxygen and github as admonitions:

Note

is translated to \note

Warning

is translated to \warning

Tip

is translated to \remark

Caution

is translated to \attention

Important

is translated to \important

However, these special blockquotes are root-level syntax only. Meaning you cannot nest these admonitions in other block elements (like list items). This limitation is due to commonmark specifications and is observed in both github and doxygen output.

also upgrades doxygen to v1.11.0 which now supports github-style admonitions.
@2bndy5 2bndy5 merged commit de5944e into master Jun 21, 2024
6 checks passed
@2bndy5 2bndy5 deleted the doxygen-css-update branch June 21, 2024 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants