Skip to content

alerts.md

Latest commit

 

History

History
102 lines (78 loc) · 2.34 KB

alerts.md

File metadata and controls

102 lines (78 loc) · 2.34 KB

Alerts

[TOC]

The doxygen-awesome-alerts extension provides support for GitHub's alert syntax. See [Markdown] An option to highlight a "Note" and "Warning" using blockquote (Beta) for more information.

Usage

Installation

  • Ensure you have doxygen-awesome properly configured for this project
  • Add doxygen-awesome/doxygen-awesome-alerts.js to HTML_EXTRA_FILES in your Doxyfile

Tip

If you have already created a custom HTML_HEADER you can skip the next 2 steps

  • Run doxygen -w html header.html delete_me.html delete_me.css in a command prompt and delete the files called delete_me

  • Set HTML_HEADER to the path of your header.html file in your Doxyfile

  • Add

<script type="text/javascript" src="$relpath^doxygen-awesome-alerts.js"></script>

to the <head> node of your header.html

  • Activate the extension by also putting
<script type="text/javascript">DoxygenAwesomeAlerts.init();</script>

into your header.html's <head> node.

The supported tags

Marker
[!NOTE]
[!TIP]
[!IMPORTANT]
[!WARNING]
[!CAUTION]

will now be replaced in all quotes.

Example

[!NOTE]

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

Note

Highlights information that users should take into account, even when skimming.

[!TIP]

> [!TIP]
> Optional information to help a user be more successful.

Tip

Optional information to help a user be more successful.

[!IMPORTANT]

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

Important

Crucial information necessary for users to succeed.

[!WARNING]

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

Warning

Critical content demanding immediate user attention due to potential risks.

[!CAUTION]

> [!CAUTION]
> Negative potential consequences of an action.

Caution

Negative potential consequences of an action.

Sanity checks

Single line

[!CAUTION]

No tag

Foo Bar

[!UNRECOGNIZED]

[!UNRECOGNIZED] This will not be replaced

[!UNCLOSED

[!UNCLOSED The tag was not closed, so this will not be replaced either.