Admonitions Preview


Here are some basic admonitions!

Note
This is a "note" admonition.
Info
This is an "information" admonition.
Important
This is an "important" admonition.
Tip
This is a "tip" admonition.
Hint
This is a "hint" admonition.
Warning
This is a "warning" admonition.
Attention
This is an "attention" admonition.
Danger
This is a "danger" admonition.
Error
This is an "error" admonition.
Question
This is a "question" admonition.
See Also
This is a "see also" admonition.

You can also add code blocks into your admonitions!

Info
This is an inline code block.
See Also
This is a python code block that creates a counting vowel function.
# Create a function that returns the number of vowels a string contains
def count_vowels():
    """
    Counts the number of vowels a string contains.
    """

    vowels = 'aeiou'
    count = 0
    for char in string.lower():
        if char in vowels:
            count += 1
    return count

result = count_vowels('example')
print(result)