Markdown-syntaxgids
Een heldere spiekbrief voor alledaagse Markdown. Elk blok toont de syntaxis en het resultaat dat je krijgt.
Wat is Markdown?
Markdown is een lichte manier om opmaak aan platte tekst toe te voegen. In plaats van knoppen en menu's gebruik je een paar eenvoudige tekens, zoals # voor een kop of * voor nadruk, die ook als ruwe tekst leesbaar blijven.
Markdown is in 2004 bedacht door John Gruber en Aaron Swartz en is de standaard geworden voor READMEs, documentatie, notities en sites als GitHub en Reddit. Omdat het gewoon tekst is, blijft je schrijfwerk overal overdraagbaar en leesbaar.
Deze gids behandelt de syntaxis die je het vaakst gebruikt. Open een voorbeeld in Markdown Peek en druk op de spatiebalk om te wisselen tussen de brontekst en het opgemaakte resultaat.
Koppen
Begin een regel met één tot zes #-tekens. Meer hekjes betekent een kleinere, diepere kop.
Markdown
# Heading 1 ## Heading 2 ### Heading 3 #### Heading 4
Resultaat
Heading 1
Heading 2
Heading 3
Heading 4
Vet, cursief en meer
Zet tekst tussen tekens om nadruk te geven. Combineer ze naar believen.
Markdown
**Bold text** *Italic text* ***Bold and italic*** ~~Strikethrough~~ `Inline code`
Resultaat
Bold text
Italic text
Bold and italic
Strikethrough
Inline code
Lijsten
Gebruik een streepje, sterretje of plusteken voor opsommingstekens en cijfers voor genummerde lijsten. Spring in om te nesten.
Markdown
- First item - Second item - Nested item - Third item 1. Step one 2. Step two
Resultaat
- First item
- Second item
- Nested item
- Third item
- Step one
- Step two
Links
Zet de zichtbare tekst tussen rechte haken en het adres tussen haakjes. Een gewoon web- of e-mailadres wordt vanzelf een link.
Markdown
[Markdown Peek](https://markdownpeek.com) https://markdownpeek.com
Afbeeldingen
Een afbeelding is een link met een uitroepteken ervoor. De tekst tussen de haken is de alt-tekst.
Markdown
Resultaat
Citaten
Begin een regel met > om te citeren. Voeg nog een > toe om een citaat in een citaat te nesten.
Markdown
> A quote worth remembering. > > > And a nested one.
Resultaat
A quote worth remembering.
And a nested one.
Code
Zet code in een regel tussen enkele backticks en hele blokken tussen drie backticks. Voeg een taalnaam toe en Markdown Peek kleurt de code in, zoals GitHub.
Markdown
Use `backticks` for inline code.
```js
function hi() {
console.log("Hello");
}
```Resultaat
Use backticks for inline code.
function hi() {
console.log("Hello");
}Tabellen
Scheid kolommen met verticale streepjes en onderstreep de kopregel met streepjes. Dubbele punten bepalen de uitlijning.
Markdown
| Feature | Supported | |---------|:---------:| | Tables | Yes | | Code | Yes |
Resultaat
| Feature | Supported |
|---|---|
| Tables | Yes |
| Code | Yes |
Horizontale lijnen
Drie of meer streepjes, sterretjes of underscores op een eigen regel tekenen een scheidingslijn.
Markdown
Above the line. --- Below the line.
Resultaat
Above the line.
Below the line.
Takenlijsten
Een lijstitem met [ ] is een openstaande taak en [x] is een voltooide.
Markdown
- [x] Read the guide - [ ] Set as default app
Resultaat
Opmerkingsblokken
Begin een citaat met [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] of [!CAUTION] om er een gekleurd opmerkingsblok van te maken, zoals op GitHub.
Markdown
> [!NOTE] > Useful to know, even when skimming. > [!WARNING] > Needs attention right away.
Resultaat
Note
Useful to know, even when skimming.
Warning
Needs attention right away.
Voetnoten
Zet [^1] waar een noot hoort en schrijf de noot ergens eronder. Markdown Peek nummert de noten, zet ze aan het eind op een rij en linkt terug naar waar je was.
Front matter
Sleutel-waardeparen tussen twee regels met --- helemaal bovenaan een bestand, zoals in blogberichten en agentvaardigheden, worden getoond als nette tabel.
Markdown
--- title: Lofoten author: Sam tags: travel --- # Five nights in March
Resultaat
| title | author | tags |
|---|---|---|
| Lofoten | Sam | travel |
Five nights in March
Tekens escapen
Zet een backslash voor een teken om het letterlijk te tonen in plaats van als opmaak.
Markdown
\*Not italic\* \# Not a heading
Resultaat
*Not italic*
# Not a heading
Wiskunde met LaTeX
Zet LaTeX tussen enkele dollartekens voor wiskunde in een zin, of tussen dubbele dollartekens voor een formule op een eigen regel. Markdown Peek toont beide, offline.
Markdown
Inline math like $E = mc^2$ works in a sentence. $$ a^2 + b^2 = c^2 $$
Resultaat
Inline math like E = mc2 works in a sentence.
a2 + b2 = c2
Diagrammen met Mermaid
Open een omheind codeblok met mermaid en beschrijf een stroomdiagram of sequentiediagram in platte tekst. Markdown Peek tekent het voor je, in lichte of donkere modus.
Markdown
```mermaid flowchart LR A[Write] --> B[Preview] B --> C[Share] ```
Resultaat
Lees Markdown prachtig op je Mac
Markdown Peek toont elk .md-bestand in nette GitHub-stijl, met code in kleur, Quick Look in Finder en bewaren als PDF. Gratis in de Mac App Store.
