Elk Markdown-element met een voorbeeld dat u kunt bewerken en direct gerenderd ziet: regeleinden, links, tabellen, checkboxes, voetnoten, codeblokken en GitHub-alerts, plus een README-sjabloon.
Markdown maakt gewone tekst op met een paar symbolen: # voor koppen, **twee sterretjes** voor vet, [tekst](adres) voor links, - voor opsommingen en drie backticks voor codeblokken. Elk voorbeeld hieronder kunt u bewerken, en de preview ernaast wordt bijgewerkt terwijl u typt, zodat u een syntax kunt testen voordat u hem gebruikt.
De vijf die u het meest gebruikt
Achttien live voorbeelden die alles behandelen van koppen tot voetnoten en GitHub-alerts, een tabel met de verschillen tussen GitHub en standaard CommonMark, een README-sjabloon en een volledige editor onderaan de pagina.
Eindig de regel met twee spaties of een backslash en druk dan op Enter. Een gewone Enter wordt als spatie behandeld en de regels worden samengevoegd. Laat voor een nieuwe alinea in plaats van een regeleinde één lege regel.
Begin een lijstitem met - [ ] voor een leeg vakje of - [x] voor een aangevinkt vakje. Takenlijsten horen bij GitHub Flavored Markdown, dus ze werken op GitHub, GitLab en de meeste notitie-apps, maar niet in strikte CommonMark.
Schrijf de kopregel met pipes tussen de kolommen, dan een regel met streepjes, dan één regel per rij. De kolommen hoeven in de bron niet uitgelijnd te zijn. Voeg dubbele punten toe aan de regel met streepjes om een kolom links, rechts of gecentreerd uit te lijnen.
Markdown is de oorspronkelijke syntax uit 2004, die veel gevallen ongedefinieerd liet. CommonMark is een precieze specificatie van die kernsyntax. GitHub Flavored Markdown is CommonMark plus tabellen, takenlijsten, doorhalen, automatische links en voetnoten, en is wat de meeste ontwikkelaarstools volgen.
De meeste renderers staan het toe, dus details- en summary-tags of een gecentreerde afbeelding zijn gebruikelijk in README's. GitHub verwijdert om veiligheidsredenen scripts, styles en sommige attributen. De previews op deze pagina renderen geen ruwe HTML en tonen die dus als tekst.
Eén tot zes #-tekens, dan een spatie. Gebruik één #-kop per document.
Underscores (__bold__, _italic_) werken ook, maar niet midden in een woord.
Twee tildes aan elke kant. Onderdeel van GitHub Flavored Markdown, niet van de kern van CommonMark.
Een enkele Enter breekt de regel niet af. Eindig met twee spaties of een backslash, of laat een lege regel voor een nieuwe alinea.
Tekst tussen vierkante haken, adres tussen ronde haken. Punthaken maken een kaal adres klikbaar.
Houdt lange adressen uit de tekst. De definities kunnen overal staan en worden niet getoond.
Zoals een link met ! ervoor. De tekst tussen haken is de alt-tekst die schermlezers voorlezen.
Gebruik -, * of + voor opsommingstekens en 1. voor nummers. Spring twee tot vier spaties in om te nesten.
Een spatie tussen de haken is niet aangevinkt; een x is aangevinkt. Op GitHub kunt u ze in issues aanvinken.
Begin elke regel met >. Een regel met alleen > houdt de alinea's in één citaat.
Backticks houden tekst precies zoals getypt. Om een backtick te tonen, omring hem met twee: `` a`b ``.
Drie backticks ervoor en erna. Het woord na de openingsfence noemt de taal voor syntax highlighting.
Pipes scheiden kolommen; de regel met streepjes is verplicht. Dubbele punten bepalen de uitlijning: links, rechts of gecentreerd.
Drie of meer streepjes, sterretjes of underscores op een eigen regel. Laat lege regels rond streepjes, zodat ze niet als onderstreping van een kop worden gelezen.
De noot wordt onderaan het document verzameld met een link terug.
Een backslash vóór * _ # [ ] ` en vergelijkbare tekens toont ze als platte tekst.
GitHub maakt van kale adressen links. Strikte CommonMark heeft punthaken nodig.
GitHub toont deze als gekleurde vakken; andere apps tonen een gewoon citaat, zoals de preview hier doet.
Markdown-syntax en waar hij werkt
Waar GitHub Flavored Markdown afwijkt van CommonMark
Overal
GitHub en de meeste apps
Alleen GitHub
Markdown (bewerk mij)
Preview
Kopiëren
Herstellen
Syntax in één oogopslag
Elk element, live
GitHub vs CommonMark
README-sjabloon
Sjabloon kopiëren
Openen in de editor
Volledige editor
Markdown
Markdown kopiëren
{n} woorden. Er wordt niets opgeslagen of verstuurd.
Gratis beginnen · Geen creditcard nodig