Ich bin nicht allzu vertraut mit der leichten Markup-Sprache, die Github beim Aktualisieren von README-Dateien verwendet.
Wo sind die Ressourcen, die ich lesen kann, um die entsprechende Markup-Syntax für die README / Wiki-Dateien meiner Open Source-Bibliothek zu schreiben?
Und gibt es ein Tool, mit dem ich "meine Dokumente lokal in meinem Browser überprüfen" kann, bevor ich die aktualisierte README-Datei in mein Github-Repository verschiebe?
( Veröffentlichen Sie diese Antwort mit einigen Änderungen erneut.)
Ein bisschen spät zum Spiel, aber ich habe eine kleine CLI in Python geschrieben. Es heißt Grip (Github Readme Instant Preview) . Wenn Sie Patricks Antwort ergänzen, können Sie "meine Dokumente lokal in meinem Browser überprüfen".
Installieren Sie es mit:
Und um es zu benutzen, einfach:
Besuchen Sie dann
localhost:5000
, um diereadme.md
Datei an diesem Speicherort anzuzeigen .Sie können auch Ihre eigene Datei angeben:
Und ändern Sie den Port:
Oder kombinieren Sie die beiden vorherigen:
Sie können sogar GitHub-Flavored Markdown (dh wie Kommentare und Probleme gerendert werden) rendern, optional mit Repo-Kontext, um Verweise auf andere Probleme automatisch per Hyperlink zu verknüpfen:
Der Kürze halber sehen Sie sich die restlichen Optionen und ihre Details mithilfe der CLI-Hilfe an:
Bemerkenswerte Eigenschaften:
Hoffe das hilft. Schau es dir an .
quelle
Hier gibt es einen netten Online- / Live-Editor:
http://jbt.github.io/markdown-editor/
Es gibt auch einen
Preview
Button bei GitHub.Im folgenden Screenshot sehen Sie, dass diese Schaltfläche angezeigt wird, wenn ich auf Bearbeiten geklickt habe
README.md
.IMHO ist der Live- Editor besser als der aktuelle bei GitHub.
AKTUALISIEREN
Erst jetzt habe ich nach der Suche nach
Markdown
und Visual Studio festgestellt, dass Sie, wenn Sie VS verwenden, Web Essentials installieren undMarkdown
Unterstützung direkt in Visual Studio erhalten können. Das ist cool!Es hat:
Details dazu hier .
quelle
Beachten Sie, dass Sie seit Februar 2014 mit " Rendered Prose Diffs " auch die gerenderte Version eines Diff in einer Markdown-Datei sehen können:
quelle
Eine weitere Option: Der neue Texteditor von Github, Atom, rendert beim Bearbeiten Markdowns mit Github-Geschmack. Siehe https://atom.io/
Ich bin mir nicht sicher, ob es langfristig kostenlos sein wird (wie bei Bier).
quelle
Ab heute können Sie eine Vorschau anzeigen, während Sie die Datei bearbeiten.
quelle
Ich fand nicht, dass die anderen Werkzeuge gut genug waren - ich wollte:
Darauf habe ich mich letztendlich festgelegt: https://github.com/ypocat/gfms
Also habe ich Aliasing:
Wenn Sie die
-p
Option verwenden, wird die Github-API aufgerufen und das aktuelle Github-CSS verwendet, sodass keine Überraschungen auftreten.quelle