Skip to content

Cheatsheet

Meta

Type Syntax
meta data
---
Tag: INFRA
---

Tables

table_formatting.png

Fenced code blocks

Start with a line containing 3 or more backtick characters, and ends with the first line with the same number of backticks:

Formatting

Type Syntax
highlight Use: fencing.png
Example: mkdocs-ew

Admonitions

Use these codes to display texts in coloured boxes. The icons and the colours are defined by the applied theme.

Type Syntax
!!! note This is a note inside a styled box.
!!! info Informational box.
!!! tip Helpful tip.
!!! warning Warning message.
!!! danger Critical alert.
!!! question
!!! note "Outer Note" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
!!! note "Inner Note" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
nested_admonition.png
Leaving out the title Add an empty string directly after the type qualifier. !!! note ""

Reusing content

To reuse a text block in multiple files:

  1. Create a folder "_resources".
  2. Create separate files for each reusable block.
  3. Reference to the respective file in "resources" from other files where the content is to be reused: --8<-- "folder/_resources/reusable_file"

img.png

img_1.png

Changelog

Date Author Message
2026-02-26 aresnikowa qc-0: How to reuse content
2026-02-25 aresnikowa Merge remote-tracking branch 'origin/master'