Markdown reference

# Markdown reference Examples of often used Markdown syntax used throughout the documentation ## Alerts ### Info Using [marked-alert](https://www.npmjs.com/package/marked-alert) ### Examples > [!NOTE] > Highlights information that users should take into account, even when skimming. _code_: ``` > [!NOTE] > Highlights information that users should take into account, even when skimming. ``` > [!TIP] > Optional information to help a user be more successful. _code_: ``` > [!TIP] > Optional information to help a user be more successful. ``` > [!IMPORTANT] > Crucial information necessary for users to succeed. _code_: ``` > [!IMPORTANT] > Crucial information necessary for users to succeed. ``` > [!WARNING] > Critical content demanding immediate user attention due to potential risks. _code_: ``` > [!WARNING] > Critical content demanding immediate user attention due to potential risks. ``` > [!CAUTION] > Negative potential consequences of an action. _code_: ``` > [!CAUTION] > Negative potential consequences of an action. ``` ## Extended tables ### Info Via [marked-extended-tables](https://www.npmjs.com/package/marked-extended-tables) ### Examples | H1 | H2 | |--------------|---------| | This cell | Cell A | | spans three ^| Cell B | | rows ^| Cell C | _code_: ``` | H1 | H2 | |--------------|---------| | This cell | Cell A | | spans three ^| Cell B | | rows ^| Cell C | ``` | This header spans two || Header A | | columns *and* two rows ^|| Header B | |-------------|------------|----------| | Cell A | Cell B | Cell C | _code_: ``` | This header spans two || Header A | | columns *and* two rows ^|| Header B | |-------------|------------|----------| | Cell A | Cell B | Cell C | ``` |Column One|Column Two|Column Three| |--10%-----|-- 40% ---|:---50%-----| _code_: ``` |Column One|Column Two|Column Three| |--10%-----|-- 40% ---|:---50%-----| ``` ## Admonition ### Info Via [marked-admonition-extension](https://www.npmjs.com/package/marked-admonition-extension) !!! example Replace `$TYPE` with the examples below ``` !!! $TYPE this is a `$TYPE` type admonition The warning above was a `$TYPE` type admonition !!! ``` and without body ``` !!! $TYPE this is a `$TYPE` type admonition without body !!! ``` !!! ### Examples !!! abstract this is a `abstract` type admonition The warning above was a `abstract` type admonition !!! !!! abstract this is a `abstract` type admonition without body !!! !!! attention this is a `attention` type admonition The warning above was a `attention` type admonition !!! !!! attention this is a `attention` type admonition without body !!! !!! bug this is a `bug` type admonition The warning above was a `bug` type admonition !!! !!! bug this is a `bug` type admonition without body !!! !!! caution this is a `caution` type admonition The warning above was a `caution` type admonition !!! !!! caution this is a `caution` type admonition without body !!! !!! danger this is a `danger` type admonition The warning above was a `danger` type admonition !!! !!! danger this is a `danger` type admonition without body !!! !!! example this is a `example` type admonition The warning above was a `example ` type admonition !!! !!! example this is a `example` type admonition without body !!! !!! failure this is a `failure` type admonition The warning above was a `failure ` type admonition !!! !!! failure this is a `failure` type admonition without body !!! !!! hint this is a `hint` type admonition The warning above was a `hint ` type admonition !!! !!! hint this is a `hint` type admonition without body !!! !!! info this is a `info` type admonition The warning above was a `info ` type admonition !!! !!! info this is a `info` type admonition without body !!! !!! note this is a `note` type admonition The warning above was a `note` type admonition !!! !!! note this is a `note` type admonition without body !!! !!! question this is a `question` type admonition The warning above was a `question` type admonition !!! !!! question this is a `question` type admonition without body !!! !!! quote this is a `quote` type admonition The warning above was a `quote` type admonition !!! !!! quote this is a `quote` type admonition without body !!! !!! success this is a `success` type admonition The warning above was a `success` type admonition !!! !!! success this is a `success` type admonition without body !!! !!! tip this is a `tip` type admonition The warning above was a `tip` type admonition !!! !!! tip this is a `tip` type admonition without body !!! !!! warning this is a `warning` type admonition The warning above was a `warning` type admonition !!! !!! warning this is a `warning` type admonition without body !!!