Markdown uitgelegd in 5 minuten
Je hebt waarschijnlijk Markdown gebruikt zonder het te weten. Ooit **vet** getypt in een Slack-bericht? Een README geschreven op GitHub? Een Reddit-post opgemaakt? Dat is Markdown.
Markdown is een lichtgewicht manier om platte tekst op te maken met eenvoudige symbolen. In plaats van op werkbalkknoppen te klikken voor vet, cursief, koppen en lijsten, typ je een paar tekens die de gewenste opmaak aangeven. Het werd in 2004 gemaakt door John Gruber en Aaron Swartz, en het is sindsdien de standaard opmaaktaal geworden voor ontwikkelaars, schrijvers en iedereen die met tekst op het web werkt.
Waarom Markdown bestaat
Voor Markdown betekende tekst opmaken voor het web dat je HTML moest schrijven. Om een woord vet te maken, typte je <strong>vet</strong>. Om een lijst te maken, had je <ul><li>item</li></ul> nodig. HTML is krachtig maar uitgebreid en moeilijk leesbaar in onbewerkte vorm.
Markdown lost dit op door een mensvriendelijke afkorting te bieden. De onbewerkte tekst is gemakkelijk te lezen, zelfs voordat deze wordt weergegeven. De opgemaakte uitvoer is strak en professioneel. Je krijgt het beste van twee werelden: leesbare brontekst en gepolijste uitvoer.
Wist je dat? De ontwerpfilosofie van Markdown is dat de onbewerkte tekst "publiceerbaar moet zijn zoals hij is, als platte tekst, zonder eruit te zien alsof hij is voorzien van tags of opmaakinstructies." Daarom gebruikt Markdown-syntax tekens die visueel de opmaak suggereren die ze produceren.
De essentiële syntax
Hier is alles wat je moet weten om productief met Markdown te beginnen.
Koppen
Gebruik hekjes (#) om koppen te maken. Meer hekjes betekent kleinere koppen.
# Kop 1 (grootst)
## Kop 2
### Kop 3
#### Kop 4
Vet en cursief
Omsluit tekst met sterretjes of underscores:
**vetgedrukte tekst**
*cursieve tekst*
***vet en cursief***
Lijsten
Ongeordende lijsten gebruiken streepjes, sterretjes of plustekens. Geordende lijsten gebruiken nummers.
- Eerste item
- Tweede item
- Derde item
1. Eerste stap
2. Tweede stap
3. Derde stap
Links
Vierkante haken voor de tekst, ronde haken voor de URL:
[Klik hier](https://example.com)
Afbeeldingen
Net als links, maar met een uitroepteken ervoor:
Citaten
Gebruik een groter-dan-teken:
> Dit is een citaat. Het wordt ingesprongen en anders opgemaakt.
Code
Backticks voor inline code, driedubbele backticks voor codeblokken:
Gebruik de `print()` functie om tekst weer te geven.
Voor meerregelige codeblokken gebruik je driedubbele backticks met een optionele taalidentificatie:
```python
def hello():
print("Hello, world!")
```
Horizontale lijnen
Drie of meer streepjes, sterretjes of underscores:
---
Tabellen
Gebruik pipes en streepjes:
| Naam | Rol | Locatie |
| --- | --- | --- |
| Alice | Ontwikkelaar | Berlijn |
| Bob | Designer | Londen |
Waar Markdown wordt gebruikt
Markdown is overal:
Softwareontwikkeling
- GitHub, GitLab, Bitbucket: README's, issues, pull requests en documentatie worden allemaal in Markdown geschreven.
- Stack Overflow: Vragen en antwoorden gebruiken Markdown-opmaak.
- Codedocumentatie: Veel documentatiegeneratoren (Docusaurus, MkDocs, Jekyll) gebruiken Markdown als bronformaat.
Communicatie
- Slack: Ondersteunt een subset van Markdown voor berichtopmaak.
- Discord: Gebruikt Markdown voor vet, cursief, codeblokken en meer.
- Reddit: Berichten en reacties worden opgemaakt met Markdown.
Schrijven en publiceren
- Blogs: Veel statische sitegeneratoren gebruiken Markdown-bestanden als inhoudsbronnen.
- Boeken: Meerdere publicatietools accepteren Markdown-manuscripten.
- Notities: Apps zoals Obsidian, Notion, Bear en Typora zijn gebouwd rond Markdown.
Documentatie
- Technische docs: API-documentatie, gebruikershandleidingen en wiki's gebruiken veelal Markdown.
- Interne kennisbanken: Veel teams gebruiken op Markdown gebaseerde wiki's.
Tip Je kunt Markdown nu meteen bekijken en oefenen, gratis, in je browser: Schrijven in Markdown. Bekijk je opgemaakte uitvoer in realtime terwijl je typt.
Markdown-varianten
Een ding om te weten: er zijn verschillende "varianten" van Markdown. De kernsyntax is overal hetzelfde, maar sommige platformen voegen uitbreidingen toe:
| Variant | Extra functies | Gebruikt door |
|---|---|---|
| CommonMark | Strikte specificatie | Algemene standaard |
| GitHub Flavored Markdown (GFM) | Takenlijsten, tabellen, doorhalen, auto-linking | GitHub |
| MultiMarkdown | Voetnoten, citaten, metadata | Academisch schrijven |
| R Markdown | Ingebedde R-code, data-analyse | Data science |
De verschillen zitten vooral in geavanceerde functies. De basis (koppen, vet, cursief, lijsten, links, afbeeldingen, code) werkt overal hetzelfde.
Veelgemaakte fouten
Lege regels vergeten
Markdown vereist een lege regel voor en na veel elementen. Een kop heeft een lege regel ervoor nodig. Een lijst heeft een lege regel ervoor en erna nodig. Het vergeten van deze lege regels is de meest voorkomende oorzaak van weergaveproblemen.
Inconsistente lijsttekens
Het mixen van -, * en + in dezelfde lijst kan onverwachte weergave veroorzaken. Kies er één en houd je eraan.
Spaties na symbolen
Sommige Markdown-processors vereisen een spatie na de # in koppen en na - in lijsten. Voeg altijd de spatie toe om veilig te zijn.
# Correcte kop
#Incorrecte kop
- Correct lijstitem
-Incorrect lijstitem
Waarschuwing Markdown ondersteunt niet alle opmaakbehoeften. Als je complexe lay-outs, gekleurde tekst, precieze typografie of drukklare documenten nodig hebt, heb je mogelijk HTML, LaTeX of een tekstverwerker nodig. Markdown is het beste voor gestructureerde, tekstgerichte inhoud.
Waarom Markdown de moeite waard is om te leren
Markdown kost vijf minuten om te leren en bespaart uren in de loop der tijd. Als je het eenmaal kent, kun je:
- Documentatie schrijven die prachtig wordt weergegeven op GitHub
- Berichten opmaken in Slack en Discord zonder de muis aan te raken
- Gestructureerde notities maken die overdraagbaar zijn tussen apps
- Blogposts en webinhoud maken vanuit platte tekstbestanden
- Samenwerken aan tekstdocumenten zonder problemen met formaatcompatibiliteit
De verhouding tussen investering en opbrengst is een van de beste in de hele technische wereld.
Begin nu met schrijven in Markdown:
Gratis, in je browser, met realtime voorvertoning terwijl je typt.