Markdown-formatter

Wat de formatter herstelt

• Lijstmarkeringen. *, -, + worden allemaal genormaliseerd naar één consistent teken (standaard -).
• Kophiërarchie. Waarschuwt (of verhoogt) wanneer een H2 wordt gevolgd door een H4 zonder H3 ertussen.
• Lege regels. Precies één lege regel tussen blokken; geen reeksen van drie of meer.
• Tabellen. Vult elke kolom op zodat de pipes (|) in de bron uitlijnen, ook al kan het Markdown-renderers niet schelen.
• Afsluitende witruimte. Verwijdert afsluitende spaties op elke regel, behalve de opzettelijke regeleinde-markering met twee spaties.
• Referentielinks. Verzamelt [label]: url-definities aan het einde van het document, alfabetisch gesorteerd.
• Code-fences. De taaltag wordt genormaliseerd naar kleine letters; op inspringing gebaseerde codeblokken worden fenced blokken.

Stijlopties die u kunt instellen

Waarom consistente Markdown ertoe doet

In een teamrepo produceert inconsistente Markdown rommelige diffs: elke keer dat iemand een bestand met een andere editor opslaat, wisselen lijstmarkeringen en herschikken tabellen zich. Een formatter dwingt één stijl af, zodat reviewers van pull requests alleen inhoudswijzigingen zien. Beschouw het als prettier voor proza.

Wanneer niet op te maken

• Fenced codeblokken blijven byte voor byte intact, de formatter raakt nooit de inhoud van een codeblok aan. Als opmaak de code verandert, is dat een bug.
• Opzettelijke harde regeleinden bij smalle breedtes (readme.md in een terminalproject) worden opnieuw afgebroken als u de afbreekkolom inschakelt. Schakel afbreken uit als u handmatig afgestemde regeleinden behoudt.
• Ingesloten HTML-blokken gaan ongewijzigd door.

Directe vervangers

Als u een lokale CLI verkiest, gebruikt de formatter dezelfde AST-regels als remark-stringify met de remark-gfm-plug-in. prettier --parser markdown levert een vergelijkbaar resultaat.