## Naslagwerk

GitHub Markdown Callouts

Gepubliceerd maart 2026

GitHub heeft callout (alert) syntaxis toegevoegd aan GitHub Flavored Markdown. Deze gestylede blokken markeren belangrijke informatie in documentatie — opmerkingen, tips, waarschuwingen en meer. ShowMeMyMD is een van de weinige desktop-viewers die ze rendert.

## De syntaxis

Vijf callout-types

Callouts gebruiken blockquote-syntaxis met een speciale tag op de eerste regel. Het formaat is altijd hetzelfde: > [!TYPE] gevolgd door je inhoud op de volgende regel, ook voorafgegaan door >.

> [!NOTE]
> Nuttige informatie die gebruikers moeten weten,
> zelfs als ze de inhoud scannen.

NOTE — Rendert als een blauw informatieblok. Gebruik het voor aanvullende context die nuttig maar niet kritiek is. Denk aan 'trouwens'-informatie.

> [!TIP]
> Nuttig advies om dingen beter
> of makkelijker te doen.

TIP — Rendert als een groen suggestieblok. Gebruik het voor best practices, snelkoppelingen of aanbevelingen die het leven van de lezer makkelijker maken.

> [!IMPORTANT]
> Belangrijke informatie die gebruikers moeten weten
> om hun doel te bereiken.

IMPORTANT — Rendert als een paars nadrukblok. Gebruik het voor informatie die essentieel is om te begrijpen voordat je verder gaat. Geen waarschuwing, maar iets dat je niet kunt overslaan.

> [!WARNING]
> Dringende info die directe aandacht nodig heeft
> om problemen te voorkomen.

WARNING — Rendert als een geel waarschuwingsblok. Gebruik het voor potentiële problemen, valkuilen of dingen die mis kunnen gaan als de lezer niet oplet.

> [!CAUTION]
> Waarschuwt over risico's of negatieve gevolgen
> van bepaalde acties.

CAUTION — Rendert als een rood gevarenblok. Reserveer dit voor onomkeerbare bewerkingen, scenario's met gegevensverlies of acties die dingen kapot kunnen maken.

## Gebruikstips

Effectieve callouts schrijven

Gebruik ze spaarzaam

Te veel callouts creëren visuele ruis. Als alles belangrijk is, is niets belangrijk. Een pagina vol gekleurde blokken traint lezers om ze te negeren. Een of twee per sectie is meestal de juiste hoeveelheid.

Stem het type af op de ernst

Gebruik geen CAUTION voor een kleine tip. Gebruik geen NOTE voor iets dat een database kan verwijderen. De kleurcodering bestaat om lezers een direct signaal te geven over de ernst — respecteer dat.

Houd de inhoud beknopt

Callouts werken het beste met een tot drie zinnen. Als je meerdere alinea's nodig hebt, hoort de informatie waarschijnlijk in de hoofdtekst, niet in een callout-blok.

Je kunt andere elementen nesten

Code-spans, links, vet en cursief werken allemaal binnen callouts. Begin elke regel met > om de inhoud binnen het callout-blok te houden.

## Compatibiliteit

Waar callouts worden gerenderd

Tool	Callout-ondersteuning
GitHub (web)	Volledig — gekleurde blokken met iconen
ShowMeMyMD	Volledig — gestylede callouts op desktop
Sommige VS Code-extensies	Verschilt per extensie
De meeste andere markdown-viewers	Nee — toont een gewone blockquote
Standaard CommonMark-renderers	Nee — gewone blockquote
Oudere GFM-parsers	Nee — gewone blockquote

De meeste markdown-viewers tonen gewoon een blockquote.

ShowMeMyMD rendert de volledige gestylede callout — gekleurde zijbalk, icoon en correcte opmaak — precies zoals het op GitHub verschijnt. Als je README's of documentatie schrijft met callouts, is dit een van de weinige manieren om ze lokaal op Mac te bekijken.

## Lees verder

Lees meer over ShowMeMyMD als Markdown-viewer voor Mac. Ontdek waarom ontwikkelaars het kiezen als hun ontwikkelaars markdown-viewer. Of bewaar onze Markdown cheat sheet.

Bekijk callouts lokaal

Stop met pushen naar GitHub alleen om te zien hoe je callouts eruitzien. ShowMeMyMD rendert NOTE, TIP, IMPORTANT, WARNING en CAUTION — direct op je Mac. $2.99 in de Mac App Store.