Advanced Formatting

Quizzes support full markdown formatting in questions, answers, and content sections. They automatically use the same markdown_extensions configured in your mkdocs.yml, enabling features like syntax highlighting, admonitions, and more.

Rich Content Section

The content section (revealed after answering) supports headers, lists, links, and any other markdown:

ExampleSyntax

#

What is MkDocs?

A static site generator

A database

A web server

A framework

About MkDocs

MkDocs is a fast, simple and downright gorgeous static site generator.

Key features:

• Written in Python
• Uses Markdown for content
• Includes live preview server
• Themeable with many themes available

Learn more at mkdocs.org

<quiz>
What is MkDocs?
- [x] A static site generator
- [ ] A database
- [ ] A web server
- [ ] A framework

## About MkDocs

MkDocs is a **fast**, **simple** and **downright gorgeous** static site generator.

Key features:

- Written in Python
- Uses Markdown for content
- Includes live preview server
- Themeable with many themes available

[Learn more at mkdocs.org](https://www.mkdocs.org)
</quiz>

Code Blocks

Include code examples in your quizzes and content sections:

ExampleSyntax

#

Which loop syntax is correct in Python?

for item in items:

for (item in items)

foreach item in items

Here's a complete example:

fruits = ["apple", "banana", "cherry"]
for fruit in fruits:
    print(fruit)

This will print each fruit on a new line.

<!-- MKDOCS_QUIZ_PLACEHOLDER_2 -->

Code with Line Highlighting

If you have pymdownx.highlight configured, you can use line numbers and highlighting:

ExampleSyntaxmkdocs.yml

#

What line prints "hello"?

Line 2

Line 1

Line 3

def greet():
    print("hello")
    return True

<quiz>
What line prints `"hello"`?
- [x] Line 2
- [ ] Line 1
- [ ] Line 3

```python hl_lines="2"
def greet():
    print("hello")
    return True
```
</quiz>

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences

Code in Questions

You can also include code blocks in the question itself:

ExampleSyntax

#

Testing markdown_extensions. Python code int | str:

def checksum(a):
    assert 2 + 2 == 4

3

4 (not four)

5

<quiz>
Testing `markdown_extensions`. Python code `#!py int | str`:

```python title="test_file.py" linenums="42" hl_lines="3"
def checksum(a):
    assert 2 + 2 == 4
```

- [ ] 3
- [x] 4 *(not `four`)*
- [ ] 5

</quiz>

Admonitions

Use admonition callout boxes in quiz content:

ExampleSyntax

#

What type of admonition is shown below?

A warning

An error

A note

Warning

This is a warning admonition!

<quiz>
What type of admonition is shown below?
- [x] A warning
- [ ] An error
- [ ] A note

!!! warning
    This is a warning admonition!
</quiz>

Requires the admonition extension in your mkdocs.yml.

Tables

Include tables in your content sections:

ExampleSyntax

#

What's special about this formula: E = mc²?

It calculates electricity

It relates mass and energy

It describes gravity

Einstein's famous equation shows:

Symbol	Meaning
E	Energy
m	Mass
c	Speed of light

The equation reveals that mass and energy are interchangeable!

<quiz>
What's special about this formula: E = mc²?
- [ ] It calculates electricity
- [x] It relates mass and energy
- [ ] It describes gravity

Einstein's famous equation shows:

| Symbol | Meaning |
|--------|---------|
| E | Energy |
| m | Mass |
| c | Speed of light |

The equation reveals that mass and energy are interchangeable!
</quiz>

Images

Include images in the content section:

ExampleSyntax

#

Which programming language has this logo?

Python

JavaScript

Ruby

Python's logo features two intertwined snakes!

<quiz>
Which programming language has this logo?
- [x] Python
- [ ] JavaScript
- [ ] Ruby

![Random cat photo](https://cataas.com/cat)

Python's logo features two intertwined snakes!
</quiz>

Supported Extensions

All markdown extensions configured in your mkdocs.yml work within quizzes, including:

Extension	Features
pymdownx.superfences	Enhanced code blocks
pymdownx.highlight	Syntax highlighting with options
pymdownx.inlinehilite	Inline code highlighting
admonition	Callout boxes
attr_list	Add attributes to elements
tables	Markdown tables
pymdownx.tabbed	Content tabs

Important Notes

1. Content must be valid markdown: The content section is processed as markdown
2. Extensions must be enabled: Features like admonitions require the corresponding extension in mkdocs.yml
3. Nesting code blocks: When showing quiz syntax in documentation, use more backticks/tildes than the inner block

Next Steps

• Learn about Multiple Choice quiz syntax
• Learn about Fill-in-the-Blank quizzes
• Configure extensions in Configuration