Command Palette
Search for a command to run

Markdown reference

Table of contents

  1. Markdown reference
  2. Alerts
  3. Info
  4. Examples
  5. Extended tables
  6. Info
  7. Examples
  8. Admonition
  9. Info
  10. Examples

Markdown reference

Examples of often used Markdown syntax used throughout the documentation

Alerts

Info

Using 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

Examples

H1 H2
This cell spans three rows Cell A
Cell B
Cell C

code:

| H1           | H2      |
|--------------|---------|
| This cell    | Cell A  |
| spans three ^| Cell B  |
| rows        ^| Cell C  |
This header spans two columns and two rows Header A
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

code:

|Column One|Column Two|Column Three|
|--10%-----|-- 40% ---|:---50%-----|

Admonition

Info

Via marked-admonition-extension

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

this is a abstract type admonition

The warning above was a abstract type admonition

this is a abstract type admonition without body

this is a attention type admonition

The warning above was a attention type admonition

this is a attention type admonition without body

this is a bug type admonition

The warning above was a bug type admonition

this is a bug type admonition without body

this is a caution type admonition

The warning above was a caution type admonition

this is a caution type admonition without body

this is a danger type admonition

The warning above was a danger type admonition

this is a danger type admonition without body

this is a example type admonition

The warning above was a example type admonition

this is a example type admonition without body

this is a failure type admonition

The warning above was a failure type admonition

this is a failure type admonition without body

this is a hint type admonition

The warning above was a hint type admonition

this is a hint type admonition without body

this is a info type admonition

The warning above was a info type admonition

this is a info type admonition without body

this is a note type admonition

The warning above was a note type admonition

this is a note type admonition without body

this is a question type admonition

The warning above was a question type admonition

this is a question type admonition without body

this is a quote type admonition

The warning above was a quote type admonition

this is a quote type admonition without body

this is a success type admonition

The warning above was a success type admonition

this is a success type admonition without body

this is a tip type admonition

The warning above was a tip type admonition

this is a tip type admonition without body

this is a warning type admonition

The warning above was a warning type admonition

this is a warning type admonition without body