Admonitions¶

Usage¶

Admonitions follow a simple syntax: !!! followed by a type qualifier, the content is then put on the next line with an indent Tab.

!!! question
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod 
    nulla. Curabitur feugiat, tortor non consequat finibus.

Changing the Title¶

You can change the title by adding a quoted string. You can use Markdown in your titles (links, formatting, etc.).

!!! tip "Whatever Title You Want"
    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Removing the Title¶

You can completely remove the title and only render an outline by adding an empty string after !!!

!!! example ""
    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Collapsible Blocks¶

You can have a collapsible block using ???.

??? note
    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

You can also force the expansion of the block using ???+

???+ note
    Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Nestable Admonitions¶

You can add admonitions that are nested inside of each other.

Inline Blocks¶

!!! info inline end "Admonition on the Right"

    Lorem ipsum dolor sit amet, consectetur
    adipiscing elit. Nulla et euismod nulla.
    Curabitur feugiat, tortor non consequat
    finibus, justo purus auctor massa, nec
    semper lorem quam in massa.

!!! info inline "Admonition on the Left"

    Lorem ipsum dolor sit amet, consectetur
    adipiscing elit. Nulla et euismod nulla.
    Curabitur feugiat, tortor non consequat
    finibus, justo purus auctor massa, nec
    semper lorem quam in massa.

Admonition Types¶

• Note
• Abstract
• Info
• Top
• Success
• Question
• Warning
• Failure
• Danger
• Bug
• Example
• Quote
• GHDesk
• VSC

Note¶

Abstract¶

Info¶

Tip¶

Success¶

Question¶

Warning¶

Failure¶

Danger¶

Bug¶

Example¶

Quote¶

GHDesk¶

VSC¶