Admonitions

Usage

You can use admonitions with the following syntax:

{% include admonition.html type="important" body="This is information intended to draw attention." %}

Optionally, a custom title can be added:

{% include admonition.html type="hint" title="Custom Title" body="This is information intended to draw attention." %}

Types

Valid types of admonitions are:

• attention
• caution
• danger
• error
• hint
• important
• note
• seealso
• tip
• todo
• warning

Examples

Simple-Tabs

Usage

You can use simple tabs with the following syntax:

{% include tabs.html tabs=page.simple-tabs-example %}

The tabs object must have a name and content field. The content field should be a string when using simple tabs.

Example

Indexed-Tabs

Usage

You can use indexed tabs with the following syntax:

{% include tabs.html tabs=page.indexed-tabs-examples index=0 %}

The tabs object must have a name and content field. The content field should be an array of strings when using indexed tabs.

Examples

Index 0

curl -L https://example.com

import requests
response = requests.get('https://example.com')
print(response.text)

Index 1

curl -L https://google.com

import requests
response = requests.get('https://google.com')
print(response.text)