Markdown cheat sheet: GitHub-Flavored syntaxis met voorbeelden

Markdown is de eenvoudigste manier om opgemaakte tekst te schrijven die ook als platte tekst leesbaar blijft. README-bestanden, documentatie, notities, chatberichten en statische websites gebruiken het allemaal. Deze cheat sheet (of spiekbriefje) behandelt de syntaxis die je echt gebruikt, met de nadruk op GitHub-Flavored Markdown (GFM) — het dialect dat wordt ondersteund door GitHub, GitLab, de meeste documentatietools en Markdown Preview Editor.

Elk voorbeeld hieronder kun je in de online editor plakken om het resultaat ernaast te zien.

Koppen

Begin een regel met één tot zes #-tekens, gevolgd door een spatie. Eén # is de paginatitel, ## een sectie, ### een subsectie.

markdown# Paginatitel
## Sectie
### Subsectie
#### Kleinere kop

Gebruik één #-kop per document en sla geen niveaus over (bijvoorbeeld van ## direct naar ####). Schermlezers en zoekmachines gebruiken de kopstructuur om de pagina te begrijpen, en de meeste voorbeeldweergaven bouwen er een inhoudsopgave van.

Alinea’s en regeleinden

Een alinea bestaat uit een of meer regels tekst, gescheiden door een lege regel. Een enkel regeleinde binnen een alinea wordt genegeerd — de regels worden samengevoegd. Wil je een regeleinde afdwingen, eindig de regel dan met twee spaties of een backslash:

markdownEerste regel met twee spaties aan het eind  
Tweede regel in dezelfde alinea.

Na een lege regel begint een nieuwe alinea.

Nadruk

Veel editors, waaronder Markdown Preview Editor, ondersteunen ook een paar populaire uitbreidingen: ==markering==, H~2~O voor subscript, x^2^ voor superscript en emoji-shortcodes zoals :smile:. Die horen niet bij GFM zelf, dus controleer je doelplatform voordat je erop vertrouwt.

Lijsten

Gebruik -, * of + voor opsommingslijsten en cijfers voor genummerde lijsten. Spring twee tot vier spaties in om items te nesten.

markdown- Melk
- Brood
  - Volkoren
  - Rogge
- Koffie

1. Kloon de repository
2. Installeer de dependencies
3. Voer de build uit

Genummerde lijsten hebben niet de juiste cijfers nodig — 1. op elke regel wordt nog steeds weergegeven als 1, 2, 3. Begin je met een ander getal (bijvoorbeeld 5.), dan begint de lijst daar.

Takenlijsten

Takenlijsten zijn een GFM-uitbreiding die lijstitems in selectievakjes verandert. Ze zijn ideaal voor README’s, releaseplannen en vergadernotities.

markdown- [x] Concept schrijven
- [x] Screenshots toevoegen
- [ ] Bericht publiceren

Links

markdown[Linktekst](https://example.com)
[Link met een titel](https://example.com "Zichtbaar bij aanwijzen")
<https://example.com>

Lees de [installatiehandleiding][install].

[install]: https://example.com/docs/install

De laatste vorm is een referentielink: de URL wordt één keer onderaan het document gedefinieerd, waardoor lange alinea’s leesbaar blijven. Relatieve links zoals [Setup](docs/setup.md) verwijzen naar andere bestanden in hetzelfde project; in Markdown Preview Editor schakelen ze naar dat document als het in een ander tabblad geopend is.

Afbeeldingen

Afbeeldingen gebruiken de linksyntaxis met een uitroepteken ervoor. De tekst tussen vierkante haken is de alternatieve tekst — beschrijf de afbeelding voor mensen die hem niet kunnen zien.

markdown![Editor met live voorbeeld](images/screenshot.png)
![Logo](https://example.com/logo.svg "Optionele titel")

Bekijk je een document dat naar lokale afbeeldingen verwijst, open dan de hele map of sleep de afbeeldingen samen met het .md-bestand erin, zodat de voorbeeldweergave de relatieve paden kan vinden.

Code

Inline code gebruikt enkele backticks. Voor blokken zet je de code tussen drie backticks en voeg je de naam van de taal toe voor syntaxmarkering:

markdown```js
function greet(name) {
  return `Hello, ${name}!`;
}
```

Veelgebruikte taalnamen: js, ts, python, bash, json, yaml, html, css, sql, go, rust, diff. Bevat je code zelf drie backticks, omsluit hem dan met vier backticks, zoals in het voorbeeld hierboven.

Tabellen

Scheid kolommen met verticale strepen en zet een regel streepjes onder de kop. Dubbele punten in de scheidingsregel bepalen de uitlijning.

markdown| Functie   | Gratis | Opmerkingen                |
|:----------|:------:|---------------------------:|
| Voorbeeld |   ✅   | Bijgewerkt terwijl je typt |
| Export    |   ✅   | HTML, PDF, .md             |

:--- lijnt links uit, :---: centreert en ---: lijnt rechts uit. De kolommen hoeven in de bron niet netjes onder elkaar te staan — maar een goede editor houdt ze leesbaar. Markdown Preview Editor heeft een tabelknop in de werkbalk die een kant-en-klaar sjabloon invoegt.

Citaten en meldingen

Zet > voor regels om tekst te citeren. GitHub ondersteunt ook meldingen (alerts) — citaten met een speciale eerste regel die als gekleurde kaders worden weergegeven:

markdown> Een gewoon citaat.

> [!NOTE]
> Nuttige informatie die gebruikers moeten weten.

> [!TIP]
> Handig advies om dingen beter te doen.

> [!WARNING]
> Dringende informatie die direct aandacht vraagt.

De vijf typen meldingen zijn NOTE, TIP, IMPORTANT, WARNING en CAUTION. Gebruik ze spaarzaam: één melding per sectie valt op, vijf achter elkaar worden ruis.

Voetnoten

Voetnoten houden zijopmerkingen uit de hoofdtekst. De noot kan overal worden gedefinieerd; hij wordt aan het eind van het document weergegeven.

markdownMarkdown is in 2004 bedacht.[^1]

[^1]: Door John Gruber, met hulp van Aaron Swartz.

Horizontale lijnen en escapen

Drie of meer streepjes, sterretjes of underscores op een eigen regel vormen een horizontale lijn: ---. Zet er een lege regel voor, anders maakt --- onder een regel tekst van die tekst een kop.

Wil je een teken tonen dat Markdown anders zou interpreteren, escape het dan met een backslash: \*niet cursief\*, \# geen kop, \$5 (handig als formules zijn ingeschakeld).

Formules en diagrammen

Twee uitbreidingen zijn standaard geworden in technische teksten:

• Formules — $E = mc^2$ voor inline formules en $$ … $$ voor losse vergelijkingen. Zie de volledige handleiding over wiskundige formules in Markdown.
• Diagrammen — een codeblok met de taal mermaid tekent stroomdiagrammen, sequentiediagrammen, Gantt-diagrammen en meer. Zie Mermaid-diagrammen in Markdown.

Front matter

Statische sitegeneratoren lezen metadata uit een YAML-blok helemaal bovenaan het bestand:

yaml---
title: Mijn bericht
date: 2026-09-27
tags: [markdown, docs]
---

Een goede voorbeeldweergave verbergt dit blok in plaats van het als tekst te tonen. Markdown Preview Editor doet precies dat.

Hoe verder

De syntaxis kennen is het halve werk — de andere helft is het resultaat zien terwijl je schrijft. Lees hoe je Markdown online bekijkt zonder je bestanden te uploaden, en als je document klaar is, ontdek hoe je Markdown omzet naar HTML of pdf.