373 Stimmen

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

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?

3voto

Eduardo Punkte 22038

Das sollten Sie sich vielleicht ansehen:

https://github.com/kristjanjansen/md2html

3voto

Eric Punkte 18690

Pour Github o Bitbucket Thema, könnte Online-Editor verwenden mattstow , url: http://writeme.mattstow.com

2voto

Mariano Cali Punkte 116

Ich verwende markdownlivepreview:
https://markdownlivepreview.com/

Es ist sehr leicht, einfach und schnell.

2voto

VonC Punkte 1117238

Seit 2012 (als diese Frage erstellt wurde) kann GitHub selbst:

  • Erstellen und Anzeigen einer Vorschau eines Markdown-Dokuments in einem regulären Repository (das war schon immer so, seit Aug. 2011 )
  • oder, wenn Sie Ihr Repository nicht direkt beeinflussen wollen, tun Sie dasselbe mit . ( seit Dez. 2020 )
    Auch ohne einen Gist festzulegen, können Sie seit November 2021 eine Vorschau Markdown-Dokument in einer Gist Sie bearbeiten (sind aber noch nicht festgelegt)

https://i1.wp.com/user-images.githubusercontent.com/1767415/141661660-d5eb7cbe-7d98-404f-a4ea-cef648c005ee.png?ssl=1

Wenn die Vorschau dieses Gists gut aussieht, können Sie den Markdown aus dem Gist in Ihr lokales README.md add, commit und push.

2voto

resultsway Punkte 10521

Eine Suche im Internet ergibt viele, hier ist eine: https://stackedit.io/

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X