Syntaxis uitproberen

Syntaxreferentie

Wat is Markdown Syntaxis?

Markdown is een lichtgewicht tekstopmaaktaal gemaakt door John Gruber in 2004. Het gebruikt eenvoudige symbolen en tekens om tekst op te maken, zodat het eenvoudig is om inhoud te schrijven die wordt omgezet naar HTML zonder er rommelig uit te zien in de ruwe vorm. Markdown is de standaard geworden voor documentatie, README-bestanden, blogs en alle inhoud die eenvoudige, leesbare opmaak nodig heeft.

CommonMark is de meest breed geaccepteerde specificatie voor Markdown, die definieert hoe parsers de syntaxis moeten interpreteren. Door CommonMark-compatibele syntaxis te leren, wordt je inhoud consistent weergegeven op GitHub, GitLab, Discord, Slack, Reddit, Stack Overflow en tientallen andere platforms. De originele Markdown-specificatie van John Gruber blijft fundamenteel, terwijl extensies zoals GitHub Flavored Markdown functies toevoegen zoals takenlijsten, doorgestreepte tekst en tabellen.

Moderne Markdown is beschikbaar in meerdere varianten die zijn afgestemd op specifieke platforms. GitHub Flavored Markdown (GFM) voegt tabellen, selectievakjes en autolinks toe. GitLab Markdown ondersteunt vergelijkbare extensies plus diagrammen. Het leren van CommonMark-kernsyntaxis biedt een draagbare basis die overal werkt.

Hoe de Markdown Syntaxgids te gebruiken

Volg deze stappen om Markdown syntaxis te leren en uit te proberen.

Plakken, uploaden of voorbeeld laden

Plak Markdown in het linker Syntaxis uitproberen paneel, of klik op Uploaden om een .md-bestand te laden. Klik op Voorbeeld voor voorbeelddocumentatie. Het rechter Syntaxreferentie paneel toont CommonMark- en GFM-patronen.

Oefenen en raadplegen

Gebruik de referentie voor koppen, nadruk, lijsten, links, tabellen, codeblokken. Kopieer voorbeelden naar het linker paneel om ze uit te proberen. Behandelt CommonMark plus GitHub Flavored Markdown-extensies.

Kopiëren of downloaden

Klik op Kopiëren of Downloaden om de referentie op te slaan. Gebruik Wissen om opnieuw te beginnen. Alle verwerking gebeurt in je browser.

Wanneer je dit echt zou gebruiken

Documentatie schrijven

Technische documentatie, API-referentiegidsen en softwaredocumentatie worden bijna universeel geschreven in Markdown. Python Docs, Node.js-gidsen en de meeste open-sourceprojecten gebruiken Markdown voor hun documentatiesites. Een syntaxreferentie houdt je productief bij het schrijven van complexe documentatie.

README's en projectbestanden

Elk GitHub-project heeft een README.md-bestand dat het project, gebruik, installatie en bijdragerichtlijnen beschrijft. Deze bestanden zijn volledig geschreven in Markdown en zijn vaak het eerste wat gebruikers zien.

Content maken en publiceren

Blogplatforms zoals Jekyll, Hugo en Ghost accepteren Markdown voor content. Medium-achtige platforms en statische sitegeneratoren gebruiken Markdown als primair invoerformaat. Het kennen van de syntaxis helpt je sneller te schrijven en consistente opmaak te behouden.

Samenwerkingscommunicatie

Slack, Discord, GitHub-issues, pull request-opmerkingen en forumberichten ondersteunen allemaal Markdown-opmaak. Bij code-reviews, bugrapporten of chatten in teams laat Markdown je bericht duidelijk opmaken zonder de gespreksstroom te onderbreken.

Veelgestelde vragen (FAQ)

Kan ik HTML gebruiken binnen Markdown?

Ja, Markdown staat ruwe HTML toe. Als Markdown iets niet ondersteunt dat je nodig hebt, kun je HTML direct schrijven en het wordt doorgegeven aan de uitvoer. Volgens de CommonMark-specificatie worden HTML-blokken en inline HTML herkend en ongewijzigd doorgegeven. Gebruik het spaarzaam.

Wat is het verschil tussen asterisken en underscores voor nadruk?

Functioneel zijn ze identiek in CommonMark — *tekst* en _tekst_ produceren beide cursief, **tekst** en __tekst__ produceren beide vetgedrukt. De keuze is stilistisch. Veel teams geven de voorkeur aan asterisken voor consistentie en omdat ze gemakkelijker te typen zijn op de meeste toetsenborden.

Hoe werken regelafbrekingen in Markdown?

Dit is een veelvoorkomende bron van verwarring. Een enkele regelterugloop in de bron wordt behandeld als een spatie. Om een echte regelafbreking (<br> in HTML) te maken, voeg je twee spaties toe aan het einde van de regel voor je op Enter drukt, of gebruik je een backslash voor de regelterugloop. Voor alinea-afbrekingen gebruik je een lege regel.

Worden tabellen overal in Markdown ondersteund?

Nee. Tabellen maken deel uit van GitHub Flavored Markdown en andere extensies, maar niet de CommonMark-standaard. De meeste moderne platforms (GitHub, GitLab, Discord) ondersteunen ze, maar sommige oudere Markdown-parsers herkennen de pijpsyntaxis niet.

Hoe escape je speciale tekens?

Gebruik een backslash (\) voor tekens met speciale betekenis in Markdown: backslash (\), backtick (`), asterisk (*), underscore (_), accolades ({}), vierkante haakjes ([]), ronde haakjes (()), hekje (#), plus (+), min (-), punt (.) en uitroepteken (!). Bijvoorbeeld rendeert \*niet cursief\* de asterisken letterlijk.

Wat is de beste manier om code op te maken in Markdown?

Voor inline code gebruik je enkele backticks: `code hier`. Voor codeblokken gebruik je drievoudige backticks met een optioneel taallabel (```javascript) voor syntaxiskleuring. Vermijd het inspringen van code als een codeblok — omheinde blokken zijn duidelijker en draagbaarder.

Markdown Syntaxgids