Markdown-Formatter

Was der Formatter behebt

• Listenmarker. *, -, + werden alle auf ein konsistentes Zeichen (Standard -) normalisiert.
• Überschriftenhierarchie. Warnungen (oder Beförderungen), wenn H2 von H4 ohne H3 dazwischen gefolgt wird.
• Leerzeilen. Genau eine Leerzeile zwischen Blöcken; keine aufeinanderfolgenden drei oder mehr.
• Tabellen. Polstert jede Spalte, sodass die Pipes im Quelltext ausgerichtet sind, auch wenn Markdown-Renderer das nicht interessiert.
• Nachfolgender Leerraum. Entfernt nachfolgende Leerzeichen in jeder Zeile, außer beim absichtlichen Zeilenumbruchmarker mit zwei Leerzeichen.
• Referenzlinks. Sammelt [label]: url-Definitionen am Ende des Dokuments, alphabetisch sortiert.
• Codeblöcke. Der Sprach-Tag wird auf Kleinbuchstaben normalisiert; einrückungsbasierte Codeblöcke werden zu eingezäunten Blöcken.

Stiloptionen, die Sie festlegen können

Warum konsistentes Markdown wichtig ist

In einem Team-Repo erzeugt inkonsistentes Markdown laute Diffs: Jedes Mal, wenn jemand eine Datei mit einem anderen Editor speichert, wechseln die Listenmarker und Tabellen fließen um. Ein Formatter erzwingt einen Stil, sodass die Prüfer von Pull-Requests nur Inhaltsänderungen sehen. Betrachten Sie es als prettier für Prosa.

Wann nicht zu formatieren

• Eingezäunte Codeblöcke bleiben bytegenau intakt, der Formatter wird niemals den Inhalt eines Codeblocks berühren. Wenn das Formatieren den Code ändert, ist das ein Fehler.
• Absichtliche harte Umbrüche bei schmalen Breiten (readme.md in einem Terminalprojekt) werden neu umgebrochen, wenn Sie den Spaltenumbruch aktivieren. Deaktivieren Sie den Umbruch, wenn Sie manuell angepasste Zeilenumbrüche beibehalten.
• Eingebettete HTML-Blöcke bleiben unverändert.

Drop-in-Ersatz

Wenn Sie eine lokale CLI bevorzugen, verwendet der Formatter dieselben AST-Regeln wie remark-stringify mit dem remark-gfm-Plugin. prettier --parser markdown liefert ein ähnliches Ergebnis.