Markdown-parser

GFM (GitHub Flavored Markdown) is een dialect van Markdown dat door GitHub wordt gebruikt. Het breidt standaard Markdown uit met functies zoals tabellen, takenlijsten, doorgestreepte tekst en automatische links.

De parser rendert codeblokken met hekwerk. Voor volledige syntaxismarkering met kleuren kunt u deze combineren met een CSS-stylesheet die code-elementen stijlt.

Ja! Schrijf uw Markdown in de editor, kopieer de gerenderde HTML en gebruik het in uw documentatie, blog of website.

De oorspronkelijke Markdown (2004) liet veel randgevallen ongedefinieerd, waardoor implementaties uiteenliepen. CommonMark is de strenge specificatie die ze oplost; GFM (GitHub Flavored Markdown) is CommonMark plus uitbreidingen: tabellen, takenlijsten, doorgestreepte tekst, automatische links en een disallowed-raw-HTML-filter. Deze tool rendert GFM, in overeenstemming met wat u op GitHub ziet.

Wikkel inline code in enkele backticks. Blokken met hekwerk gebruiken driedubbele backticks met een taaltag voor syntaxismarkering - zoals ```python op de openingsregel - of spring elke regel in met vier spaties (de oudere syntaxis, die slecht samenwerkt binnen lijsten). Driedubbele tildes werken ook als hekwerk wanneer uw code zelf backticks bevat.

Ja - inline HTML-tags gaan door naar de uitvoer. De disallowed-raw-HTML-uitbreiding van GFM verwijdert alleen enkele gevaarlijke tags (script, style, iframe en dergelijke) wanneer het filter is ingeschakeld. Twee kanttekeningen: HTML op blokniveau omhult inhoud waarbinnen Markdown-syntaxis niet meer wordt verwerkt (lege regels doen ertoe), en door gebruikers ingediende Markdown moet naast een tagfilter ook tegen XSS worden gesaneerd.

Met pipes gescheiden rijen met een scheidingsregel van streepjes onder de koptekst. Dubbele punten bepalen de uitlijning: dubbele punt-streep links is links (de standaard), dubbele punten aan beide uiteinden centreren, streep-dubbele punt rechts. Cellen kunnen geen blokelementen bevatten; escape een letterlijke pipe als \|; en de buitenste pipes op elke rij zijn optioneel. Complexere lay-outs vereisen ruwe HTML of een documentatie-engine.

De gebruikelijke verdachten: inconsistente inspringing (geneste items moeten doorgaans uitlijnen met het eerste teken van de inhoud van het bovenliggende item), een ontbrekende lege regel tussen een alinea en een lijst, of tabs gemengd met spaties. CommonMark specificeert exacte regels voor al deze gevallen. Tabs naar spaties converteren en lege regels rond lijsten toevoegen lost de meeste nestingsbugs op.