Markdown-Syntax: Leichte Dokumentformatierung
Markdown ist die universelle Klartext-Formatierungssyntax, die von John Gruber entwickelt wurde. Es ermöglicht Autoren, strukturierte Webinhalte, Readme-Dokumentationen und Blog-Beiträge zu verfassen, ohne umständliche HTML-Tags zu berühren.
Das Einfügen proprietärer Dokumentation in Online-Editoren kann zum Verlust von geistigem Eigentum führen. Dieser Live-Editor nutzt eine Offline-Parsing-Engine, die Ihre Tastenanschläge sofort 100 % clientseitig in HTML umwandelt.
Formel & Berechnungsmethode
Nur-Text-Syntax ➔ Parsing Engine ➔ Semantische HTML-Elemente
Markdown übersetzt einfache typografische Markierungen (wie Sternchen für Fettdruck oder Hashes für Kopfzeilen) direkt in ihre semantischen HTML-Äquivalente (wie Strong- oder H1-Tags).
Best Practices & Tipps
- Verwenden Sie semantische Header: Strukturieren Sie Dokumente immer hierarchisch. Verwenden Sie ein einzelnes H1 (ein Hash) für den Titel, gefolgt von H2 (zwei Hashes) für Hauptabschnitte und H3 für Unterabschnitte.
- Nutzen Sie Codeblöcke für technische Dokumente: Verpacken Sie Codeausschnitte in dreifache Backticks und hängen Sie die Sprachkennung (z. B. Javascript oder Python) an, um die Syntaxhervorhebung in den meisten modernen Repositorys zu ermöglichen.
- Halten Sie die Absätze kurz: Markdown ist auf Weblesbarkeit ausgelegt. Teilen Sie lange Textwände in kleinere, durch Leerzeilen getrennte Absätze auf, um das kognitive Scannen drastisch zu verbessern.