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:
!!! 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 :::
Launch hyperlinks in a new tab:
Example:
<a href="https://www.google.com" target="_blank">Click Here!!</a>
Becomes: