Scribo

On this page

On this page

Admonition

The following admonitions are supported:

  • note / attention
  • tip / hint
  • info / important
  • warning / caution
  • danger / error

General Syntax

Admonition with a title

!!! admonition-name "admonition title"
    Content indented with tab.

Admonition without a title

!!! admonition-name ""
    Content indented with tab.

NOTE: The empty "" is necessary.

Note Admonition

Note Admonition Example

This is a note.

You can provide more information.

Syntax

!!! note "Note Admonition Example"
    This is a note.

    You can provide more information.

Tip Admonition

Tip Admonition example

This is a tip.

You can provide more information.

Syntax

!!! tip "Tip Admonition example "
    This is a tip.

    You can provide more information.

Info Admonition

Info Admonition example

This is an info.

You can provide more information.

Syntax

!!! info "Info Admonition example "
    This is an info.

    You can provide more information.

Warning Admonition

Warning Admonition example

This is a warning.

You can provide more information.

Syntax

!!! warning "Warning Admonition example "
    This is a warning.

    You can provide more information.

Danger Admonition

Danger Admonition example

This is a danger.

You can provide more information.

Syntax

!!! danger "Danger Admonition example "
    This is a danger.

    You can provide more information.