Markdown-formaterare

Vad formateraren fixar

• Listmarkörer. *, -, + normaliseras alla till ett konsekvent tecken (standard -).
• Rubrikhierarki. Varnar (eller befordrar) när H2 följs av H4 utan H3 emellan.
• Tomma rader. Exakt en tom rad mellan block; inga serier av tre eller fler.
• Tabeller. Fyller ut varje kolumn så att rören linjeras i källan, även om Markdown-renderare inte bryr sig.
• Avslutande blanksteg. Skalar bort avslutande mellanslag på varje rad utom den avsiktliga tvåmellanslagsmarkören för radbrytning.
• Referenslänkar. Samlar [label]: url-definitioner i slutet av dokumentet, sorterade alfabetiskt.
• Kodstaket. Språktaggen normaliseras till gemener; indragningsbaserade kodblock blir staketblock.

Stilalternativ du kan ställa in

Varför konsekvent Markdown spelar roll

I ett team-repo producerar inkonsekvent Markdown stökiga diffar: varje gång någon sparar en fil med en annan redigerare byter listmarkörer och tabeller flyter om. En formaterare framtvingar en stil så att granskare av pull requests bara ser innehållsändringar. Tänk på det som prettier för prosa.

När du inte ska formatera

• Staketkodblock förblir byte-för-byte intakta, formateraren rör aldrig innehållet i ett kodblock. Om formatering ändrar kod är det en bugg.
• Avsiktliga hårda ombrytningar vid smala bredder (readme.md i ett terminalprojekt) bryts om igen om du aktiverar ombrytningskolumnen. Inaktivera ombrytning om du behåller handjusterade radbrytningar.
• Inbäddade HTML-block passerar oförändrade.

Direktersättningar

Om du föredrar en lokal CLI använder formateraren samma AST-regler som remark-stringify med insticksprogrammet remark-gfm. prettier --parser markdown ger ett liknande resultat.