---
title: "Markdown cheat sheet"
manual: "How to Document"
version: "main"
permalink: "https://docs.typo3.org/permalink/h2document:md-cheat-sheet"
source: "Basics/MdCheatSheet.rst"
rendered: "2026-09-19T10:25:29+00:00"
---

# Markdown cheat sheet {#md-cheat-sheet}

See commonly used Commonmark Markdown Syntax in the
TYPO3 Documentation Theme:

**Cheat Sheet**

-   [Headlines and anchors](https://docs.typo3.org/permalink/h2document:headlines-and-anchors)
-   [References and linking](https://docs.typo3.org/permalink/h2document:references-and-linking)
-   [Code blocks](https://docs.typo3.org/permalink/h2document:code-blocks)
-   [Figures and images](https://docs.typo3.org/permalink/h2document:figures-and-images)
-   [Lists, ordered and unordered](https://docs.typo3.org/permalink/h2document:lists-ordered-and-unordered)
-   [Inline text roles](https://docs.typo3.org/permalink/h2document:inline-text-roles)
-   [Comments](https://docs.typo3.org/permalink/h2document:comments)
-   [Admonitions](https://docs.typo3.org/permalink/h2document:admonitions)

## Headlines and anchors {#md-cheat-sheet-headlines-anchors}

Each document must have a title of level 1. You can use headers of additional
levels, only use level 1 once per Markdown document

```md
# Document header

Some text.

## H2 Headline

Lorem Ipsum

### H3 Headline

Lorem Ipsum
```

## References and linking {#md-cheat-sheet-links}

References to documentation from the TYPO3 world should be copied from the wizard:

![](../_Images/link-headlines.png)

They then look like this:

```md
[Configuration of the rendering - guides.xml](https://docs.typo3.org/permalink/h2document:guides-xml)
```

External links can be copied into the document they will be auto detected. Or
the standard md Syntax can be used:

```md
See also https://www.typo3.org or (the TER)[https://extensions.typo3.org].
```

## Code blocks {#md-cheat-sheet-code-blocks}

Use the standard Markdown syntax for code blocks:

```md
```php
<?php
defined('TYPO3') or die();
```

Lorem Ipsum Dolor: `$dolor`...

``Use `code` in your Markdown file.``
```

## Figures and images {#md-cheat-sheet-images}

```md
![Alternative Text](/_Images/a4.jpg "Some Caption")
```

-   [Guidelines for creating images](https://docs.typo3.org/permalink/h2document:guidelines-for-images)

## Lists, ordered and unordered {#md-cheat-sheet-lists}

```md
- unordered
- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
  nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
  sed diam voluptua.
- list

1.  ordered
2.  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
    nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
    sed diam voluptua.
10. list
```

## Inline text roles {#md-cheat-sheet-inline}

```md
*italic text*, **bold text**, `$code = 'My Code'`
```

## Comments {#md-cheat-sheet-comments}

Comments can be written like this:

```md
<!-- this is a comment -->
```

## Admonitions {#md-cheat-sheet-admonitions}

We support the rendering of the following GitHub Markdown style admonitions
(Warning, Tip, etc):

```md
> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
```