Wie man Markdown schnell auf GitHub und Reddit verwendet

Informatec Digital » Ressourcen » Wie man Markdown schnell auf GitHub und Reddit verwendet

Wer häufig auf GitHub schreibt oder viel Zeit auf Reddit verbringt, für den ist Markdown eine wertvolle Fähigkeit, die viel Zeit spart und das Leben erleichtert. Es handelt sich um eine sehr schlanke Auszeichnungssprache, mit der sich einfacher Text schnell formatieren lässt – ganz ohne Menüs oder Schaltflächen, sondern mit nur wenigen Symbolen an den richtigen Stellen.

Auf GitHub findet man Markdown überall: in den README.md- Dateien der Repositories , in Issues, Pull Requests, Diskussionen und sogar im eigenen Profil. Reddit hingegen verwendet eine Variante namens Snoomark (Reddit-Markdown), die viel von der GitHub-Syntax übernimmt, aber auch einige Besonderheiten und Einschränkungen aufweist. Wir zeigen Ihnen Schritt für Schritt und anhand zahlreicher Beispiele, wie Sie Markdown auf GitHub und Reddit schnell und ohne wichtige Informationen zu verpassen verwenden können .

Was ist Markdown und warum ist es auf GitHub und Reddit so nützlich?

Markdown ist eine leichtgewichtige Auszeichnungssprache, die das Lesen und Schreiben von Klartext vereinfacht und gleichzeitig die problemlose Konvertierung in HTML ermöglicht. Konkret bedeutet das, dass Sie normalen Text schreiben und einige Sonderzeichen hinzufügen können, um Überschriften, Listen, Tabellen, Zitate, formatierten Code, Links oder Bilder zu erstellen.

Auf GitHub kommt GitHub Flavored Markdown (GFM) zum Einsatz, das die klassische Syntax um Tabellen, Aufgabenlisten, erweitertes Code-Highlighting, Farbunterstützung, Warnmeldungen und einige zulässige HTML-Tags erweitert. All dies wird automatisch in .md-Dateien und in den Kommentarfeldern der Plattform dargestellt.

Reddit verwendet einen eigenen Editor namens Snoomark, eine Weiterentwicklung von GFM. Er teilt viele der grundlegenden Funktionen (fett, kursiv, Überschriften, Listen, Zitate, Inline- oder Blockcode, Links usw.), weist aber wichtige Besonderheiten auf : Beispielsweise ist die Bildunterstützung je nach Kontext eingeschränkter, und es werden eigene Elemente wie Spoiler hinzugefügt.

Das Schöne daran ist, dass man mit einer einzigen Syntax Texte verfassen kann, die sowohl auf GitHub als auch auf Reddit gut aussehen. Man muss lediglich einige Details anpassen, da die Plattformen unterschiedlich funktionieren. Wer die Grundregeln kennt, kann sich auf beiden Plattformen problemlos bewegen, ohne alles von Grund auf neu lernen zu müssen.

Überschriften und Inhaltsstruktur

Eines der ersten Dinge, die Sie verwenden werden, sind Überschriften , sowohl auf GitHub als auch auf Reddit. Sie helfen dabei, den Text in Abschnitte und Unterabschnitte zu gliedern.

In Markdown wird eine Überschrift erstellt, indem dem Text ein bis sechs Hash-Symbole vorangestellt werden: eines für eine Überschrift der Ebene 1, zwei für Ebene 2 usw. bis Ebene 6. In einer GitHub README.md-Datei könnte dies beispielsweise so aussehen: # Haupttitel , ## Abschnitt , ### Unterabschnitt usw.

Wenn GitHub zwei oder mehr Überschriften in einer Datei findet, wird automatisch ein Inhaltsverzeichnis erstellt , das über das „Gliederungs“-Symbol oben in der Datei aufgerufen werden kann. Jede Überschrift wird als Link angezeigt, der direkt zum entsprechenden Abschnitt führt – ideal für lange Dokumente.

Darüber hinaus wird jede Überschrift zu einem internen Anker, auf den Sie mit einem URL-Snippet basierend auf dem Titeltext verlinken können. Um dieses Snippet zu generieren, wendet GitHub sehr spezifische Regeln an: Buchstaben werden in Kleinbuchstaben umgewandelt, Leerzeichen durch Bindestriche ersetzt, Satzzeichen und Formatierungszeichen (wie Kursivschrift) entfernt, überflüssige Leerzeichen abgeschnitten und, falls das Ergebnis mit einer vorherigen Überschrift übereinstimmt, ein numerisches Suffix (-1, -2 usw.) angehängt , um es eindeutig zu machen.

Dies ermöglicht es Ihnen beispielsweise, einen ## Beispielabschnitt einzufügen und dann von einer anderen Stelle im Dokument mit einem Link wie (#Beispielabschnitt) darauf zu verlinken , oder sogar auf Abschnitte mit Sonderzeichen im Titel zu verlinken, da GitHub den Snippet gemäß diesen Regeln generiert und ihn mit demselben Muster zugänglich macht.

Hervorhebungen, markierter Text und Zitate

Markdown ermöglicht es, Text mithilfe verschiedener Formatierungen hervorzuheben : fett, kursiv, durchgestrichen, tiefgestellt, hochgestellt oder unterstrichen. Auf GitHub sähe eine typische Stiltabelle etwa so aus, obwohl wir sie hier anders zusammengefasst haben:

Um Text fett zu formatieren , setzen Sie ihn in doppelte Sternchen oder doppelte Unterstriche; für Kursivschrift verwenden Sie einfache Sternchen oder Unterstriche; zum Durchstreichen setzen Sie zwei Tilden (Tilden) vor und nach dem Text. Sie können auch verschachtelte Fett- und Kursivschrift kombinieren, drei Sternchen verwenden, um beides auf einen gesamten Textabschnitt anzuwenden, oder HTML-Tags wie `<b>` _{für ^{Tief- und Hochstellung und `<i>` für Unterstreichung verwenden.}}

GitHub ermöglicht es Ihnen außerdem, Blockzitate zu erstellen, indem Sie ein Größer-als-Zeichen (>) an den Zeilenanfang setzen. Der zitierte Text wird links mit einem senkrechten Strich abgetrennt und grau dargestellt, wodurch er sich deutlich abhebt. Sie können mehrere Zeilen innerhalb desselben Blockzitats verwenden und sogar Zitate verschachteln, indem Sie weitere >-Zeichen am Anfang hinzufügen.

Eine erweiterte Zitatform, die exklusiv für GitHub verfügbar ist, sind Warnmeldungen . Sie verwenden dieselbe Blockzitat-Syntax, jedoch enthält die erste Zeile ein spezielles Zeichen, das den Warnmeldungstyp angibt. Beispielsweise können Sie `alert` für nützliche Informationen, `hilfreiche Tipps`, `wichtige Daten`, `dringende Warnungen` und `Warnungen vor Risiken oder negativen Folgen` angeben. GitHub stellt jeden Typ mit einer anderen Farbe und einem anderen Symbol dar, wodurch wichtige Informationen in Ihrer Dokumentation hervorgehoben werden.

Reddit unterstützt ebenfalls einfache Zitate mit dem >-Symbol, verfügt aber nicht über das umfangreiche Ping-System von GitHub. Dennoch ist es eine sehr nützliche Möglichkeit, auf jemanden zu antworten, indem man einen Teil seiner Nachricht zitiert, ohne sie vollständig zu wiederholen.

Codehervorhebung, Blöcke und Farben

Sowohl GitHub als auch Reddit ermöglichen es, Code-Snippets im Text mithilfe von Backticks hervorzuheben. Bei Inline-Code umschließt man das Wort oder den Befehl mit je einem Backtick. Dies eignet sich ideal, um beispielsweise ` git status` innerhalb eines Satzes hervorzuheben und so deutlich zu machen, dass es sich um einen Befehl handelt.

Wenn Sie einen eigenständigen Codeblock benötigen, verwendet Markdown drei Backticks: Sie schreiben eine Zeile mit drei Backticks, dann den Code in separaten Zeilen und schließen mit weiteren drei Backticks ab. Auf GitHub wird, wenn Sie direkt nach den ersten Backticks die Sprache angeben, die Syntaxhervorhebung mit sprachspezifischen Farben und Formatierungen angewendet.

GitHub bietet außerdem eine spezielle Funktion zum Hervorheben von Farbwerten innerhalb von Backticks. Wenn Sie eine Farbe im Hexadezimal-, RGB- oder HSL-Format zwischen Backticks eingeben, fügt die Plattform neben dem Text eine kleine Farbanzeige hinzu. Wenn die Hintergrundfarbe im hellen Modus beispielsweise #ffffff und im dunklen Modus #000000 ist, können Sie durch die Hervorhebung dieser Codes schnell erkennen, welche Farbe welche ist.

GitHub bietet die Möglichkeit, in allen Kommentarfeldern eine feste Monospace-Schriftart zu aktivieren, was die Arbeit mit technischen Texten erleichtert. Wenn Sie viele Code-Snippets in Ihrem Browser oder in Editoren wie Visual Studio Code bearbeiten, sorgt diese Option für eine deutlich einheitlichere Ausrichtung und Lesbarkeit.

Reddit unterstützt auch Codeblöcke mit Backticks, sowohl inline als auch blockweise, wobei deren Verwendung dort eher auf kleine Code-Schnipsel oder Pseudocode als auf lange Dokumentationen wie die eines Repositorys ausgerichtet ist.

Links, Anker und interne Navigation

Das Erstellen von Links in Markdown ist ganz einfach: Man setzt den anzuzeigenden Text in eckige Klammern und die URL in runde Klammern. Das funktioniert sowohl auf GitHub als auch auf Reddit und lässt sich auf GitHub durch Tastenkombinationen optimieren (z. B. um markierten Text schnell in einen Link umzuwandeln).

GitHub bietet einige zusätzliche Navigationsfunktionen. Erstens ermöglicht es das direkte Verlinken von Überschriften mithilfe der zuvor erläuterten Snippet-Generierungsregeln. Zweitens unterstützt es relative Links innerhalb des Repositorys selbst, was für die technische Dokumentation unerlässlich ist.

Ein relativer Link wird anhand der aktuellen Datei als Referenz berechnet. Befindet sich beispielsweise Ihre README-Datei im Projektverzeichnis und Sie möchten auf die Datei docs/CONTRIBUTING.md verlinken, erstellen Sie einfach einen Link mit dem Pfad docs/CONTRIBUTING.md. GitHub sorgt dafür, dass dieser relative Link in jedem Branch, in dem Sie sich befinden, korrekt übersetzt wird, sodass er beim Wechseln von Branches oder beim Klonen des Repositorys nicht mehr funktioniert.

Es wird empfohlen, beim Navigieren zwischen Dateien im selben Repository stets relative Pfade zu verwenden , da absolute Links in Klonen oder Forks möglicherweise nicht mehr funktionieren. GitHub erlaubt die Verwendung von Standardoperatoren wie ./ oder ../ sowie von Pfaden, die relativ zum Projektverzeichnis mit / beginnen.

Um innerhalb eines Dokuments benutzerdefinierte Ankerpunkte jenseits von Überschriften zu erstellen, können Sie HTML-Tags mit dem Attribut `name` verwenden. Dadurch lässt sich ein Zielpunkt mitten in einem Absatz oder neben Text ohne eigene Überschrift platzieren und mit derselben Syntax wie bei automatisch generierten Überschriften verlinken.

Bilder auf GitHub: Markdown, HTML und relative Pfade

Auf GitHub werden Bilder in der Regel mit derselben Syntax wie Links eingebettet, jedoch mit einem vorangestellten Ausrufezeichen. Der Alternativtext (alt) steht in eckigen Klammern, die URL oder der Pfad zum Bild in runden Klammern. Dieser Alternativtext ist wichtig für die Barrierefreiheit , da er von Bildschirmleseprogrammen vorgelesen und angezeigt wird, falls das Bild nicht geladen werden kann.

Bilder können aus Dateien innerhalb des Repositorys selbst oder von externen URLs stammen. GitHub ermöglicht das Hochladen von Bildern aus verschiedenen Branches, anderen Repositories oder sogar Issues und Kommentaren mithilfe mehrerer relativer Pfadmuster. Bei Bedarf kann durch Suffixe wie „?raw=true“ ein direkter Dateidownload erzwungen werden.

Neben der Standard-Markdown-Syntax unterstützt GitHub auch das HTML-Element `<picture>`. Dieses Element ist besonders nützlich, um responsive Bilder zu laden , die sich an die Designeinstellungen des Nutzers (hell oder dunkel) anpassen. Mithilfe der Media-Query `prefers-color-scheme` können Sie für jeden Modus unterschiedliche Bildquellen und ein Standardbild für Browser definieren, die diese Funktion nicht unterstützen.

Das typische Muster beinhaltet das Einschließen von mehrere Elemente mit seinen media- und srcset-Attributen und schließlich einem Mithilfe des alt-Attributs und einer generischen URL sehen Benutzer im Dunkelmodus ein angepasstes Bild, während Benutzer im Hellmodus ein anderes Bild erhalten, ohne dass Inhalte in der README-Datei dupliziert werden müssen.

GitHub unterstützt auch HTML-Kommentare in Markdown-Dateien, sodass Sie unsichtbare Hinweise für den Leser hinzufügen können, beispielsweise um ihn daran zu erinnern, einen Bildabschnitt zu aktualisieren oder später neue Beispiele hinzuzufügen.

Tabellen, Ausklappabschnitte und Inhaltstrennung

Eine der nützlichsten Verbesserungen in GitHub Flavored Markdown ist die Tabellenunterstützung . Sie können Daten in Zeilen und Spalten anordnen, indem Sie senkrechte Striche zur Trennung der Zellen und eine Bindestrichzeile für die Überschrift verwenden. Außerdem können Sie Spalten rechts-, links- oder zentriert ausrichten, indem Sie in der Trennzeile einen Doppelpunkt setzen.

Tabellen eignen sich hervorragend zur Darstellung von Programmiersprachen, verwendeten Frameworks, geplanten Aufgaben, Funktionsvergleichen oder anderen Informationen, die von einer Matrixstruktur profitieren. GitHub stellt diese Tabellen übersichtlich und gut lesbar dar.

Um eine lange README-Datei übersichtlich zu gestalten, können Sie mit dem HTML-Tag `<details>` ausklappbare Abschnitte erstellen. Diese Abschnitte zeigen eine Zusammenfassung innerhalb des Tags `<summary>` an ​​und ermöglichen es dem Benutzer, weitere Inhalte je nach Bedarf ein- oder auszublenden. Es ist üblich, Tabellen oder Blöcke mit zusätzlichen Informationen in `<details>` einzuschließen, um den Benutzer nicht auf den ersten Blick zu überfordern.

Wenn der Abschnitt standardmäßig erweitert angezeigt werden soll, fügen Sie einfach das Attribut „open“ hinzu. Diese Technik eignet sich hervorragend zum Gruppieren von Ranglisten, langen Listen oder Inhalten, die für das erste Lesen nicht unbedingt notwendig sind, aber bequem zugänglich sein sollten.

Ein weiteres einfaches Hilfsmittel zur Informationsstrukturierung ist die horizontale Linie. Sie entsteht durch das Zeichnen von drei oder mehr Strichen auf einer Linie und dient dazu, eine Trennlinie zwischen Abschnitten zu ziehen. So lassen sich beispielsweise ein beschreibender Abschnitt klar von einem Abschnitt mit Literaturhinweisen oder zusätzlichen Anmerkungen abgrenzen.

Diese Regeln lassen sich mit Zitaten am Ende des Dokuments kombinieren, um inspirierende Sätze, Erinnerungen oder Kernbotschaften hervorzuheben. Ein typisches Beispiel wäre ein Motivationszitat am Ende der Profil-README-Datei, formatiert als Blockzitat nach einer Trennlinie.

Ausgeblendete Kommentare und Formatierungskontrolle

GitHub ermöglicht das Einfügen von HTML-Kommentaren in Markdown mithilfe der Syntax <!-- Kommentar -->. Der Inhalt dieses Kommentars wird zwar nicht im gerenderten Inhalt angezeigt, ist aber im Quellcode sichtbar. Dadurch eignet sich diese Syntax ideal für interne Notizen oder Aufgabenlisten.

Beispielsweise kann man in einer Profil-README einen Kommentar hinzufügen, der etwa besagt, dass man den Abschnitt „Über mich“ später erweitern muss oder dass man eine Tabelle mit veralteten Technologien überprüfen muss, ohne dass jemand, der das Profil besucht, dies direkt sieht.

Eine weitere nützliche Funktion ist das Maskieren von Zeichen , die normalerweise als Markdown interpretiert würden. Wenn Sie Sternchen, Hash-Symbole oder andere Symbole ohne Formatierung anzeigen möchten, stellen Sie einfach jedem Zeichen einen Backslash voran. Dadurch können Sie beispielsweise Ausdrücke mit Listensymbolen schreiben, ohne diese in tatsächliche Listen umwandeln zu müssen.

Wenn Sie eine Markup-Datei auf GitHub anzeigen, können Sie per Knopfdruck oben zwischen der gerenderten Ansicht und dem Quellcode umschalten (oder die Datei in Editoren wie Brackets öffnen ). Durch Deaktivieren der Markdown-Interpretation haben Sie Zugriff auf typische Codeansichtsfunktionen wie das Verlinken bestimmter Zeilen . Dies ist besonders nützlich, wenn Sie einen bestimmten Abschnitt einer README-Datei oder einer beliebigen .md-Datei hervorheben möchten.

Beachten Sie abschließend, dass GitHub Zeilenumbrüche in Kommentaren (Issues, Pull Requests usw.) und in .md-Dateien unterschiedlich handhabt. In Kommentaren werden Zeilenumbrüche direkt berücksichtigt, während Sie in Markdown-Dateien am Ende der Zeile zwei Leerzeichen, einen Backslash oder einen Punkt hinzufügen müssen. um den Sprung innerhalb desselben Absatzes zu erzwingen.

Listen, verschachtelte Listen und Aufgabenlisten

Listen gehören zu den am häufigsten verwendeten Elementen in Markdown, sowohl auf GitHub als auch auf Reddit. Ungeordnete Listen lassen sich erstellen, indem man jedem Listenelement einen Bindestrich, ein Sternchen oder ein Pluszeichen voranstellt. Diese Zeichen werden ähnlich wie Aufzählungspunkte dargestellt.

Um geordnete Listen zu erstellen , nummerieren Sie jede Zeile mit einer Zahl, gefolgt von einem Punkt und einem Leerzeichen. Die Reihenfolge der Zahlen muss nicht exakt sein (GitHub berechnet sie normalerweise neu), es empfiehlt sich jedoch, eine einheitliche Nummerierung beizubehalten, um den Quellcode lesbar zu halten.

Verschachtelte Listen entstehen einfach durch Einrücken der darunterliegenden Elemente. In nichtproportionalen Editoren wie Sublime Text müssen Sie die Markierungen der verschachtelten Liste lediglich visuell unterhalb des ersten Zeichens des Textes im übergeordneten Element ausrichten. In Kontexten wie dem GitHub-Kommentar-Editor, wo die Schriftart nicht nichtproportional ist, sollten Sie die Anzahl der Zeichen vor dem Text zählen und diese Anzahl an Leerzeichen für den Einzug verwenden.

Sie können auch mehrere Verschachtelungsebenen erstellen, solange Sie die Anzahl der Leerzeichen beibehalten. Bei sehr komplexen Listen erfordert dieses System etwas Übung, aber sobald Sie es verstanden haben, lässt es sich sehr schnell anwenden.

GitHub bietet auch Aufgabenlisten an , die sich hervorragend für Issues, Pull Requests und Dokumentation eignen. Diese Listen werden erstellt, indem man der Liste einen Bindestrich, ein Leerzeichen und zwei eckige Klammern voranstellt, in denen sich entweder ein Leerzeichen oder ein „x“ befindet: eine für ausstehende und eine für erledigte Aufgaben. Die Listen werden mit Kontrollkästchen dargestellt, die über die Benutzeroberfläche ausgewählt oder abgewählt werden können.

Beginnt der Text eines Aufgabenlisteneintrags mit Klammern, muss er mit einem Backslash maskiert werden, um Verwirrung beim Parser zu vermeiden. Das ist zwar ein kleines Detail, aber wichtig bei Beschreibungen, die mit etwas wie „(Optional)“ oder Ähnlichem beginnen.

Erwähnungen, Verweise und Emojis auf GitHub

Ein Vorteil der Verwendung von Markdown auf GitHub ist die Möglichkeit, Nutzer und Teams direkt auf der Plattform zu erwähnen . Man tippt einfach @ gefolgt vom Nutzernamen oder Teamnamen, und GitHub sendet eine Benachrichtigung an das entsprechende Konto, um dessen Aufmerksamkeit auf die Konversation zu lenken.

Wenn Sie das @-Symbol eingeben, zeigt GitHub eine Liste der mit dem Repository oder Thread verknüpften Benutzer und Teams an. Sie können diese Liste während der Eingabe filtern. Verwenden Sie die Pfeiltasten und drücken Sie die Eingabetaste oder die Tabulatortaste, um die Vorschläge zu übernehmen. Für Teams verwenden Sie das Format @Organisation/Teamname. Dadurch werden alle Teammitglieder dem Thread hinzugefügt.

Neben Erwähnungen ermöglicht GitHub das einfache Verweisen auf Issues und Pull Requests durch Eingabe von # gefolgt von einer Zahl oder einem Teil des Titels. Daraufhin erscheint eine Liste mit Vorschlägen, die Sie wie bei Erwähnungen bearbeiten können. Dies beschleunigt die Navigation zwischen verwandten Diskussionen erheblich.

Wenn in Ihrem Repository benutzerdefinierte automatische Verlinkungen konfiguriert sind, werden bestimmte externe Bezeichnungen (z. B. JIRA- oder Zendesk-Ticket-IDs) möglicherweise automatisch in Kurzlinks umgewandelt. Diese Einstellung erfordert Administratorrechte, ermöglicht aber nach der Aktivierung den systemübergreifenden Datenaustausch mit minimalem Aufwand.

GitHub unterstützt Emojis auch im Code: Geben Sie einen Doppelpunkt, gefolgt vom Emoji-Namen und einem weiteren Doppelpunkt ein. Während Sie tippen, erscheint eine Liste mit Vorschlägen, die Sie mit Tab oder Enter bestätigen können. Emojis verleihen Ihren Kommentaren eine persönlichere Note, solange Sie sie in formalen Dokumentationen nicht überstrapazieren.

Fußnoten und weiterführende Inhalte

GitHub unterstützt auch Fußnoten mithilfe einer Syntax mit eckigen Klammern und einem Bezeichner mit einem Caret-Zeichen. An der gewünschten Stelle fügen Sie etwas wie `<footnote>` ein. Am Ende des Dokuments definieren Sie den Text der Fußnote mit demselben Tag, gefolgt von einem Doppelpunkt und dem eigentlichen Inhalt.

Fußnoten können sich über mehrere Zeilen erstrecken. Um innerhalb einer Fußnote einen Zeilenumbruch zu erzwingen, werden am Zeilenende doppelte Leerzeichen verwendet, genau wie im Haupttext des Markdown-Dokuments. Bei der Darstellung zeigt GitHub eine hochgestellte Zahl im Text und am Ende eine Liste der Fußnoten mit Rückverweisen zur Navigation zwischen den Verweisen und Fußnoten an.

Eine weitere von GitHub angebotene Funktion sind die bereits erwähnten Warnmeldungen (HINWEIS, TIPP, WICHTIG, WARNUNG und VORSICHT). Es empfiehlt sich, diese nur bei Bedarf zu verwenden und nicht zu viele hintereinander anzuzeigen, um den Leser nicht zu überfordern. Da sie nicht in andere komplexe Elemente eingebettet werden können, ist eine sorgfältige Planung ihrer Platzierung unerlässlich.

Schließlich können Sie GitHub anweisen, Abschnitte des gerenderten Markdown-Codes vorübergehend auszublenden, indem Sie sie in HTML-Kommentare einschließen, oder die Verarbeitung bestimmter Zeichen mit Backslashes zu ignorieren. Dies ist besonders nützlich, wenn Sie die Markdown-Syntax selbst dokumentieren und Beispiele ohne Interpretation anzeigen möchten.

Markdown auf Reddit: Snoomark und Bearbeitungsmodus

Reddit ist eine Diskussionsplattform, auf der nahezu jedes Thema willkommen ist und in Subreddits organisiert wird. Für die Formatierung stehen zwei Editoren zur Verfügung: einer für visuell ansprechende Rich-Text-Formatierung und ein weiterer für reinen Text auf Markdown-Basis. Wer schnell arbeiten und die volle Kontrolle über das Ergebnis haben möchte, sollte die Markdown-Option verwenden.

Reddit aktiviert standardmäßig den Rich-Text-Editor. Um in den Markup-Modus zu wechseln, müssen Sie die Option „Markdown-Modus“ im Textfeld eines Beitrags oder Kommentars auswählen. Anschließend können Sie die Snoomark-Syntax direkt verwenden.

Wenn Sie den Markdown-Editor immer geladen haben möchten, gehen Sie zu Ihren Benutzereinstellungen, wählen Sie „Feed-Einstellungen“ und aktivieren Sie die Option „Standardmäßig Markdown verwenden“ . So öffnet sich der Markdown-Editor automatisch, sobald Sie einen Beitrag oder Kommentar verfassen, ohne dass Sie dies manuell einstellen müssen.

Reddit unterstützt die meisten grundlegenden und fortgeschrittenen Markdown-Funktionen: Überschriften, Fettdruck und Kursivschrift, Listen, Zitate, Codeblöcke, Links und einige eigene Erweiterungen wie Spoiler. Im Vergleich zu GitHub weist es jedoch deutliche Schwächen auf, insbesondere bei der Bildverarbeitung , die stark vom Kontext und dem verwendeten Editor abhängt.

Von Reddit unterstützte Syntax und Spoiler

Die von Reddit verwendete Snoomark-Variante weist viele Gemeinsamkeiten mit GitHub auf. Wenn Sie also bereits mit Markdown für Repositories vertraut sind, ist die Übertragung dieser Kenntnisse auf die Reddit-Umgebung recht einfach. Sie können Überschriften verwenden, um längere Beiträge zu strukturieren, nummerierte oder Aufzählungslisten, Zitate, um anderen Nutzern zu antworten, und Codeblöcke, um Befehle oder technische Code-Ausschnitte anzuzeigen.

Ein wesentlicher Unterschied liegt in der Art und Weise, wie Reddit mit Bildern umgeht . Obwohl Bilder in vielen Fällen über die grafische Benutzeroberfläche und nicht direkt mit Markdown-Syntax hochgeladen werden, verwendet Reddit dennoch Snoomark zur Verarbeitung des Textinhalts, sodass die Formatierung der Bilder tatsächlich auf Markdown basiert.

Reddit hingegen bietet zusätzliche Funktionen, die nicht in der Standardspezifikation enthalten sind, wie beispielsweise Spoiler. Diese ermöglichen es, Text hinter einer Ebene zu verbergen, die der Nutzer per Klick aufdecken kann. Technisch gesehen wandelt Reddit einen Spoiler in eine Kombination aus HTML, CSS-Klassen und plattformspezifischem JavaScript um.

Die resultierende HTML-Darstellung eines Spoilers enthält Funktionen, die steuern, wann der Inhalt angezeigt oder ausgeblendet wird. Theoretisch ließe sich etwas Ähnliches zwar auch mit reinem HTML schreiben, auf Reddit hängt dies jedoch von der internen Implementierung ab. Für Sie als Nutzer ist wichtig, dass Sie beim Schreiben lediglich die vom Editor bereitgestellte Spoiler-Syntax verwenden müssen. Snoomark kümmert sich um die Übersetzung in die entsprechende Struktur.

Kurz gesagt, Snoomark übernimmt viele Funktionen von GitHub Flavored Markdown, ist aber eher auf die Bedürfnisse einer Diskussionsplattform als auf die Projektdokumentation zugeschnitten. Der Kern bleibt jedoch gleich: Klartext mit einfachen Symbolen wird in strukturierten und lesbaren Inhalt umgewandelt.

Wer die Markdown-Syntax auf GitHub und Reddit beherrscht, gestaltet technische Dokumentationen, das Erstellen aussagekräftiger Issues, das Kommentieren von Pull Requests und die Teilnahme an Reddit-Diskussionen deutlich effizienter. Mit wenigen Grundregeln – Überschriften, Hervorhebungen, Listen, Zitate, Codeblöcke, Links, Bilder und praktischen Tricks wie Tabellen, ausklappbaren Details, Warnmeldungen, Fußnoten und Spoilern – lassen sich langweilige Texte in übersichtliche, gut lesbare und professionelle Inhalte verwandeln – ganz ohne Mausklick.