Wie kann ich testen, wie meine readme.md-Datei aussehen wird, bevor ich sie auf Github übertrage?

Question

Ich schreibe eine Readme für mein Github-Projekt im .md-Format. Gibt es eine Möglichkeit, wie ich testen kann, wie meine readme.md-Datei aussehen wird, bevor ich sie an Github übertrage?

Answer 1

Viele Möglichkeiten: Wenn Sie mit einem Mac arbeiten, verwenden Sie Mou .

Wenn Sie in einem Browser testen möchten, können Sie Folgendes versuchen StackEdit wie von @Aaron hervorgehoben oder Dillinger seit Notizblock scheint jetzt abgeschaltet zu sein. Ich persönlich benutze Dillinger, weil es einfach funktioniert und alle meine Dokumente in der lokalen Datenbank meines Browsers speichert.

Answer 2

Visual Studio-Code hat die Möglichkeit, Änderungen an md-Dateien zu bearbeiten und in der Vorschau anzuzeigen. Da VS Code plattformunabhängig ist, würde dies für Windows, Mac und Linux funktionieren.

Um zwischen den Ansichten zu wechseln, drücken Sie Strg+Umschalt+V im Editor. Sie können die Vorschau Seite an Seite betrachten (Strg+K V) mit der Datei, die Sie bearbeiten, und sehen Sie die Änderungen in Echtzeit, während Sie sie bearbeiten.

Außerdem...

F: Unterstützt VS Code GitHub Flavored Markdown?

A: Nein, VS Code zielt auf die CommonMark Markdown-Spezifikation unter Verwendung der markdown-it-Bibliothek. GitHub bewegt sich in Richtung der CommonMark-Spezifikation.

Die Schaltfläche für die Vorschau ist diese:

Weitere Einzelheiten hier

Answer 3

Atom funktioniert ohne Probleme - öffnen Sie einfach die Markdown-Datei und drücken Sie Strg+Umschalt+M um das Markdown-Vorschaufenster daneben zu aktivieren. Es verarbeitet auch HTML und Bilder.

Answer 4

Dies ist eine ziemlich alte Frage, aber da ich bei der Suche im Internet darüber gestolpert bin, ist meine Antwort vielleicht für andere nützlich. Ich habe gerade ein sehr nützliches CLI-Tool zum Rendern von GitHub flavored markdown gefunden: Griff . Es verwendet die API von GitHub und lässt sich daher recht gut rendern.

Offen gesagt, der Entwickler von Griff hat eine ausführlichere Antwort auf diese sehr ähnlichen Fragen:

• Gibt es ein Kommandozeilen-Dienstprogramm für die Wiedergabe von Github flavored Markdown?
• Wie kann ich die Readme.md von GitHub am besten bearbeiten?

Answer 5

Normalerweise bearbeite ich sie direkt auf der GitHub-Website und klicke auf "Vorschau" direkt über dem Bearbeitungsfenster.

Vielleicht ist das eine neue Funktion, die seit der Erstellung dieses Beitrags hinzugefügt wurde.