Markdown-spiekbrief

Stap 1 / 3 33%

Kies een Markdown-onderwerp

Begin met één groep voorbeelden en open daarna de volledige referentie.

Essentiële Markdown-syntaxis, per categorie geordend en weergegeven met kopieerbare broncode en de uitvoer van een echte parser. De referentie behandelt de basis van CommonMark (koppen, lijsten, nadruk, links, afbeeldingen en omheinde code) en uitbreidingen van GitHub Flavored Markdown (tabellen, takenlijsten, doorhalen en automatische links voor losse URL’s). Handig wanneer u wisselt tussen GitHub, GitLab, Obsidian en generators voor statische websites.

Zo gebruikt u de spiekbrief

  1. 1

    Blader per categorie

    Ga naar koppen, lijsten, code, links, tabellen of GFM-extensies.

  2. 2

    Vergelijk bron en resultaat

    Elk voorbeeld toont de ruwe Markdown naast de uitvoer van een echte GFM-parser.

  3. 3

    Kopieer het fragment

    Tik op kopiëren om de bron van elk voorbeeld op te halen.

  4. 4

    Controleer het syntaxislabel

    Elk voorbeeld is gemarkeerd als CommonMark of GitHub Flavored Markdown (GFM).

Koppen

# H1-kop
## H2-sectie
### H3-subsectie

Gebruik de ATX-stijl (#) in plaats van Setext (=== onder de tekst). Alle parsers ondersteunen beide, maar ATX is makkelijker te lezen in een diff.

Nadruk

*cursief* of _cursief_, **vet** of __vet__, ***vet cursief***. GFM voegt ~~doorhalen~~ toe.

Lijsten

Ongeordende lijsten gebruiken -, * of + (kies er één en houd het aan):

- Eerste
- Tweede
  - Genest (twee spaties)

Geordende lijsten worden automatisch opnieuw genummerd:

1. Item
1. Item
1. Item

Code

Inline: `code`. Omheinde blokken met een optionele taaltag:

```python
def hello(name):
    return f"Hallo, {name}"
```

Laat een codeblok met vier spaties inspringen als u de oudere syntaxis verkiest.

Links en afbeeldingen

[Linktekst](https://example.com)
[Link met titel](https://example.com "Tekstballon")
![Alt-tekst](/path/to/image.png)

De referentiestijl houdt lange URL’s buiten de alinea:

Zie de [documentatie][1].

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

Tabellen (GFM)

| Col A | Col B |
|-------|------:|
| a     |     1 |
| b     |    22 |

Uitlijning gebruikt dubbele punten in de scheidingsrij: :--- links, :---: gecentreerd, ---: rechts.

Takenlijsten (GFM)

- [x] Klaar
- [ ] Te doen

Veelvoorkomende valkuilen

  • Twee spaties aan het einde voegen een regeleinde in binnen een alinea. Eén spatie voegt de regels alleen samen.
  • Een lege regel is vereist vóór de meeste blokelementen (koppen, lijsten, codeblokken).
  • Laat lijstmarkeringen niet met tabs inspringen als uw renderer spaties verwacht; laat inspringen met twee of vier spaties.
  • Escapen met een backslash voor letterlijke leestekens: \*niet cursief\*.
  • Slimme aanhalingstekens verschillen per renderer. GitHub laat ze ongemoeid; Pandoc zet ze om.

Veelgestelde vragen

CommonMark beschrijft de draagbare kern, waaronder koppen, lijsten, links en omheinde code met een optionele informatieregel. GFM voegt tabellen, takenlijsten, doorhalen en automatische links voor losse URL’s toe. Andere editors ondersteunen mogelijk maar een deel of voegen eigen uitbreidingen toe.

Markdown behandelt een enkele nieuwe regel als een spatie. Voor een <br> eindigt u de regel met twee spaties, of gebruikt u \ aan het einde van de regel in GFM.

Ja, in de meeste parsers worden HTML-tags op blokniveau doorgegeven. Sommige renderers schonen deze op (GitHub verwijdert inline-scripts en gebeurtenisattributen).

CommonMark heeft geen ingebouwde syntaxis voor een inhoudsopgave. GitHub maakt kopankers en toont een overzicht bij bestanden met meerdere koppen. Andere platforms hebben eigen regels: MkDocs kan [TOC] gebruiken wanneer de TOC-extensie actief is, terwijl Docusaurus de pagina-inhoudsopgave uit koppen afleidt.

De regels van CommonMark en GFM wel. Obsidian voegt echter wikilinks ([[Paginanaam]]), callouts en ingesloten blokken toe die alleen in Obsidian bestaan; die staan niet in deze spiekbrief.

Gerelateerde tools