Skip to content


Thanks for considering to contribute to :)

You can fork the project and send a merge request to review.

Proposals and Feedback

You can always fork the project and suggest a change in a Merge Request as a draft.

If you've found a problem, or miss something, you can also open a new issue in the project following the template.

Preview in MkDocs

This project uses MkDocs with the Material theme. In order to render a preview, use the following options.

If you are using a tablet or mobile, we recommend to use Gitpod in your browser.


Open the project or your fork and change the selector from Web IDE to Gitpod.

Alternatively, use


Install Docker and run the container with port-forwarding to localhost:8000. The source directory is mapped into the container.

$ docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`

Local source environment

Install Python 3.9+ and pip, for example with Homebrew on macOS.

$ brew install python requires MkDocs themes and plugins which are defined in requirements.txt. Install them with the following command:

$ pip install -r requirements.txt

Depending on your environment, the pip command is called pip3.

You can run MkDocs with the following command:

$ mkdocs serve

More verbose output for debugging:

$ mkdocs serve -v

Static Build

$ docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material build

Project layout

mkdocs.yml    # The configuration file.
docs/  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Style Guide

Add items to topics

For adding tools and projects, follow the existing structure.


- [Website]()
- [Documentation]()

#### Facts

- []()

#### Hot Topics 

Example from topics/

## Tools

### Prometheus 

- [Website](
- [Documentation](

#### Facts

- Started in 2012
- [Open Source](
- [CNCF graduated project in 2018](

#### Hot Topics 

- [PromQL]( query language.
- [Metric Types](
- [Exporters]( where Prometheus can scrape metrics from.
- [Instrumentation]( for your app source, exposing `/metrics`. 

Add new topics

Consider copying an existing topic, and add it to the menu in the mkdocs.yml file.

Add Learning Resources

When adding a training resource, please ensure that you have taken the training, and can recommend the training by adding your name to the table.


Embed Youtube videos in Markdown with a preview image

[![ALT text](](

[![ALT text](](
Back to top