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:
attentioncautiondangererrorhintimportantnoteseealsotiptodowarning
Examples
Attention
This is information intended to draw attention.
Caution
This is information intended to draw attention.
Danger
This is information intended to draw attention.
Error
This is information intended to draw attention.
Hint
This is information intended to draw attention.
Important
This is information intended to draw attention.
Note
This is information intended to draw attention.
See also
This is information intended to draw attention.
Tip
This is information intended to draw attention.
TODO
This is information intended to draw attention.
Warning
This is information intended to draw attention.
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
Content of tab A
Content of tab B
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)