Skip to content

Markdown Examples

Resources

Check Material for MkDocs for Markdown syntax!

Admonitions

An Info Box that is always

Your are seeing this.

An Info Box that is hidden by default

Now, you are seeing this.

ToDo: This is how you can mark a ToDo

Danger

This is dangerous!

Warning

This is a warning!

Failure

Something went wrong

Heads up!

This is an important note.

Give me a tip

This is a hot tip.

Commenting Blocks

def hello_world():
    print("Hello, world!") # (1) This is the function definition.

# (1) Also show hidden files, even if they start with a dot.
ls -la

# (2) Check the current status of your Git repository.
git status

# (3) Update your system's package lists. Requires superuser privileges.
sudo apt update


theme:
  features:
    - content.code.annotate # (1)
  1. 🙋‍♂️ I'm a code annotation! I can contain code, formatted text, images, ... basically anything that can be written in Markdown.

Showing Alternatives

Install on Windows...

Install on macOS...

Install on Linux...