Markdown cheat sheet

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

Cheat Sheet

Headlines and 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

# Document header

Some text.

## H2 Headline

Lorem Ipsum

### H3 Headline

Lorem Ipsum

References and linking

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

Hover over a headline to see if it is linkable, then click the link icon

They then look like this:

[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:

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

Code blocks

Use the standard Markdown syntax for code blocks:

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

Lorem Ipsum Dolor: `$dolor`...

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

Figures and images

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

Guidelines for creating images

Lists, ordered and unordered

- 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

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

Comments

Comments can be written like this:

<!-- this is a comment -->

Admonitions

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

> [!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.