# Markdown syntax

This wiki uses DokuWiki's native Markdown mode. Write page content in Markdown; legacy DokuWiki markup is not enabled here.

## Headings and paragraphs

Use one to six `#` characters for headings. Separate paragraphs with a blank line.

```markdown
# Heading 1
## Heading 2
### Heading 3

This is a paragraph.

This is a second paragraph.
```

## Text formatting

| Result | Markdown |
| --- | --- |
| **Bold** | `**Bold**` |
| *Italic* | `*Italic*` |
| ***Bold and italic*** | `***Bold and italic***` |
| ~~Strikethrough~~ | `~~Strikethrough~~` |
| `Inline code` | `` `Inline code` `` |

## Links and images

Use normal Markdown link syntax. For links to wiki pages, use the page ID inside the parentheses. Prefix a page ID with `:` to link to the root namespace from a page in another namespace.

```markdown
[External site](https://example.org)
[This wiki's start page](:start)
[Another page in the wiki](wiki:dokuwiki)
[Markdown guide](wiki:syntax)
![DokuWiki logo](wiki:dokuwiki-128.png)
```

## Lists

Use `-` or `*` for unordered lists and numbers for ordered lists. Indent nested items by two spaces.

```markdown
- First item
- Second item
  - Nested item

1. First step
2. Second step
```

## Blockquotes

Start quoted lines with `>`.

```markdown
> This is a quotation.
>
> It can contain more than one paragraph.
```

## Code blocks

Use fenced code blocks. Add a language name after the opening fence for syntax highlighting.

```bash
printf 'Hello, world!\n'
```

Use single backticks for inline code, such as `docker compose up -d`.

## Tables

Use pipes and a separator row for a table.

```markdown
| Service | Status |
| --- | --- |
| Wiki | Running |
| Proxy | Running |
```

## Horizontal rules and line breaks

A line containing `---` creates a horizontal rule. For a line break within a paragraph, end the line with two spaces; a blank line starts a new paragraph.

---

## Avoid legacy DokuWiki markup

Use Markdown equivalents instead of DokuWiki-only forms such as `====== Heading ======`, `[[page|label]]`, `{{image.png}}`, or `~~NOTOC~~`. For example, write `[Page](wiki:page)` for an internal link and `![Alt text](wiki:image.png)` for an image. DokuWiki-specific macros and footnotes are not part of this Markdown mode.