Skip to content

Markdown Syntax and Formatting

Callouts/Admonitions for Azure DevOps:

Block quote formatting:

:::note The block quote formatting is intentional and calls attention to the callout vs. just having it appear as standard lines of text. :::

> :memo: **NOTE:** This is a helpful piece of information.
>
> :bulb: **TIP:** Try doing it this way to save time.
>
> :warning: **WARNING:** Be careful here to avoid breaking the build.
>
> :exclamation: **IMPORTANT:** Do not skip this configuration step.

Becomes:

📝 NOTE: This is a helpful piece of information.

💡 TIP: Try doing it this way to save time.

âš ī¸ WARNING: Be careful to avoid breaking the build.

❗ IMPORTANT: Do not skip this configuration step.

Table formatting:

| :memo: **NOTE** |
| :--- |
| This text is enclosed in a border to grab attention. |

| :warning: **WARNING** |
| :--- |
| Critical instructions go inside this box. |

Becomes:

📝 NOTE
This text is enclosed in a border to grab attention.
âš ī¸ WARNING
Critical instructions go inside this box.

| :exclamation:  IMPORTANT  |
|---------------------------|

| :zap:        Ignore at your own risk!   |
|-----------------------------------------|

| :memo:        | Take note!|
|---------------|:------------------------|

| :point_up:    | Remember! |
|---------------|:------------------------|

| :warning: WARNING          |
|:---------------------------|
| Warning     |

| :boom: DANGER              |
|:---------------------------|
| Danger! |

|:information_source: Information|
|:---------------------------|
| This is an info box! |

Becomes:

❗ IMPORTANT

⚡ Ignore at your own risk!

📝 Take Note!
â˜ī¸ Remember!
âš ī¸ WARNING
Warning
đŸ’Ĩ DANGER
Danger!
â„šī¸ Information
This is an info box!

Callouts/Admonitions in MkDocs/Zensical:

MkDocs Documentation

!!! note
    Test text

Becomes:

:::info Test text :::

!!! warning
    Test text

Becomes:

:::warning Test text :::

!!! success
    Test text

Becomes:

:::success Test text :::

!!! failure
    Test text

Becomes:

:::danger Test text :::


Example:

<a href="https://www.google.com" target="_blank">Click Here!!</a>

Becomes:

Click Here!!