Auf GitHub haben mehrere Projekte README.md
Dateien. Es scheint eine einfache Formatdatei zu sein, um Text und Bilder auszudrücken.
Ich denke, irgendwo gibt es eine Editor- oder Syntaxerklärung.
Wo finde ich eine Einführung in .md
Dateien?
markdown
file-extension
Lai Yu-Hsuan
quelle
quelle
.markdown
Erweiterung, obwohl sie so schrecklich lang ist ...markdown
: blog.wax-o.com/2014/04/… . Sie sollten versuchen, einen Markdown zu schreiben, um das Ergebnis live zu visualisieren (mit einer Anwendung wie mouapp.com ). Wussten Sie, dass die Syntax von Stackoverflow-Posts und Kommentaren auf Markdown basiert? :) stackoverflow.com/editing-helpAntworten:
Markdown ist ein Nur-Text-Dateiformat. Die Erweiterungen
.md
und.markdown
sind nur Textdateien, die in Markdown- Syntax geschrieben sind. Wenn Sie einReadme.md
in Ihrem Repo haben, zeigt GitHub den Inhalt auf der Homepage Ihres Repos an. Lesen Sie die Dokumentation:Sie können die
Readme.md
Datei in GitHub selbst bearbeiten . Klicken Sie auf Readme.md, um eine Schaltfläche zum Bearbeiten zu finden. Sie können eine Vorschau Ihrer Änderungen anzeigen und diese sogar von dort aus festschreiben.Da es sich um eine Textdatei handelt, können Notepad oder Notepad ++ (Windows), TextEdit (Mac) oder ein anderer Texteditor zum Bearbeiten und Ändern verwendet werden. Es gibt spezielle Editoren, die den Markdown während der Eingabe automatisch analysieren und eine Vorschau generieren, während andere verschiedene Syntaxfarben und Dekorationen auf den angezeigten Text anwenden. In beiden Fällen ist die gespeicherte Datei jedoch immer noch eine lesbare Textdatei.
Wenn Sie eine erstellen
md
Datei mit Vorschau und wenn Sie keine spezielle Editoren installieren möchten, können Sie Online - Editoren wie verwenden dillinger.io und stackedit.io . Sie bieten eine Live-Vorschau. Sie können Ihre Dateien auch in Google Drive oder Dropbox exportieren .quelle
Wenn Sie nach einem Editor suchen, empfehlen wir Ihnen, http://dillinger.io/ zu verwenden . Es ist ein einfacher browserbasierter Texteditor, der Markdown im laufenden Betrieb rendern kann.
Wenn Sie jedoch eine App bevorzugen und OS X verwenden, können Sie Mou ausprobieren . Es ist ziemlich gut und voller Beispiele.
quelle
Der Atom-Texteditor von Github verfügt über einen Live-Vorschaumodus für Markdown-Dateien.
Die Tastenkombination ist CTRL+SHIFT+M.
quelle
Der Visual Studio Code- Texteditor von Microsoft unterstützt integrierte MD-Dateien, die in Markdown-Syntax geschrieben wurden.
Die Syntax wird automatisch in der MD-Datei farbcodiert, und ein Vorschaufenster des gerenderten Markdowns kann durch Drücken von
Shift+Ctrl+V
(Windows) oderShift+Cmd+V
(Mac) angezeigt werden .Um sie nebeneinander anzuzeigen, ziehen Sie die Registerkarte Vorschau auf die rechte Seite des Editors oder verwenden Sie stattdessen
Ctrl+K V
(Windows) oderCmd+K V
(Mac).VS Code verwendet die markierte Bibliothek zum Parsen und aktiviert standardmäßig die Unterstützung für Github Flavored Markdown. Der Github Emoji wird jedoch nicht wie der Atom-Texteditor von Github inline angezeigt .
Für die Unterstützung von VS Code stehen außerdem mehrere Markdown-Plugins für erweiterte Funktionen zur Verfügung.
quelle
Die Erweiterung ' .md ' bezieht sich auf Markdown- Dateien.
Wenn Sie keine App installieren möchten, um sie in diesem Format zu lesen, können Sie sie einfach mit TextEdit oder Xcode selbst auf dem Mac öffnen.
Auf jedem anderen Betriebssystem sollten Sie es mit einem beliebigen Texteditor öffnen können. Wie erwartet wird es jedoch nicht im Markdown- Format angezeigt .
quelle
Ja, nur Markdown mit GitHub-Geschmack . Durch das Einfügen einer README-Datei in Ihr Repository können andere schnell feststellen, worum es geht und wie sie installiert werden. Sehr hilfreich, um in Ihre Repos aufzunehmen.
quelle
Stack Edit ist ein Online-Markdown-Editor, der in Google Drive und DropBox gespeichert werden kann.
quelle
Markdown ist nur eine Textdatei, die optional
.md
oder.markdown
Erweiterungen enthält. Es kann in HTML konvertiert werden. Informationen zur Syntax von Markdown finden Sie unter AuscheckenGitHub Flavored Markdown .
Sie können einen beliebigen Texteditor für das Markdown verwenden. Wenn Sie
sublime text
Benutzer sind, können Sie auscheckenMarkdown Preview
Plugin auschecken, das den gerenderten Markdown-Inhalt im Browser anzeigt und aktualisiert, wenn Sie die Markdown-Datei ändern.Einige der Online-Markdown-Editor
quelle
BBEdit zeigt MD auch auf dem Mac an.
und hier ist ein Quicklook-Plugin , um sie anzuzeigen, wenn Sie eine Vorschau anzeigen.
quelle
Ich schlage StackEdit vor . Es ist ein einfacher WISIWIG-Editor. Sie können sowohl die Editor- als auch die Markdown-Syntax verwenden. Dort gibt es eine schnelle Markdown-Hilfesyntax. Rückgängig / Wiederherstellen, Kommentare, GoogleDrive, Dropbox-Verbindung.
quelle
markable.in ist ein sehr schönes Online-Tool zum Bearbeiten der Markdown-Syntax
quelle
Es wird ständig versucht, Markdown zu standardisieren. Ab sofort ist dies wahrscheinlich der beste Ort, um mehr über Markdown zu erfahren:
http://standardmarkdown.com/
quelle
Wenn Sie MD-Dateien für Ihre .NET-Lösungen erstellen, empfehle ich den Visual Studio 2015-Erweiterungs- Markdown-Editor, da er über ein Vorschaufenster verfügt, damit Sie Ihre Änderungen in Echtzeit sehen können.
BEARBEITEN : Dies sollte jetzt auch mit Visual Studio 2017 funktionieren.
quelle
Wenn Sie keinen Reader haben, ist es am einfachsten, die MD-Datei mit einem Texteditor zu öffnen, die MD-Datei als HTML-Datei zu schreiben und dann mit dem Browser zu doppelklicken, um sie anzuzeigen.
quelle
Die .md steht für Markdown Text. Grundsätzlich ist es nur eine andere Art von Textdatei, wie .txt
Ich benutze Notepad ++ zum Lesen und Bearbeiten dieser
quelle