Welche Datei verwendet die Erweiterung .md und wie soll ich sie bearbeiten?

878

Auf GitHub haben mehrere Projekte README.mdDateien. 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 .mdDateien?

markdown  file-extension 
— Lai Yu-Hsuan
quelle
38
Ich denke, dies ist ein Beweis für die Verwendung der .markdownErweiterung, obwohl sie so schrecklich lang ist ...
— Endolith
7
Hier ist ein Link, der Ihnen helfen kann -> .MD File Extension
— Vipin Kr. Singh
1
MarkPad ist eine nette Anwendung für die MarkDown-Bearbeitung in Windows. Es zeigt Ihnen die Vorschau der Änderungen.
— Skjoshi
1
Benutzer können MarkView ausprobieren , eine Chrome-Erweiterung zum Bearbeiten und Anzeigen von Markdown-Dateien im Browser.
— swcool
1
Vollständiger Leitfaden für den Einstieg in 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-help
— fabien

Antworten:

733

Markdown ist ein Nur-Text-Dateiformat. Die Erweiterungen .mdund .markdownsind nur Textdateien, die in Markdown- Syntax geschrieben sind. Wenn Sie ein Readme.mdin Ihrem Repo haben, zeigt GitHub den Inhalt auf der Homepage Ihres Repos an. Lesen Sie die Dokumentation:

Sie können die Readme.mdDatei 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 mdDatei 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 .

— Dikei
quelle
27
Ich fand Githubs grundlegende Erklärung auch als kurze Einführung sehr nützlich.
— Voo
2
Unter Windows möchten Sie möglicherweise WordPad verwenden, um die Formatierung für ein einfacheres Lesen zu verwenden.
— G O'Rilla
4
@ GO'Rilla, IMHO vermeiden Sie WordPad wie die Pest, es sei denn, Sie schreiben sich kleine Notizen, die Sie niemals mit jemandem teilen werden. Was der TXT-Datei hinzugefügt wird, kann andere Editoren (vim, Notepad ++ usw.) in Mitleidenschaft ziehen. Es ist viel besser, im Text zu arbeiten, wenn Sie mit .txt arbeiten, und ein Textverarbeitungsprogramm oder Acrobat für Nicht-TXT-Textdateien wie .doc und .pdf zu verwenden.
— Labyrinth
1
Können wir Bilder hinzufügen oder über einen Link in der MD-Datei ... ist das möglich?
— Raphael
1
@ user1645290 Ja, das ist möglich. siehe
— B-GangsteR
87

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.

— sirLisko
quelle
2
Es scheint wieder zum Leben zu erwecken?
— GuiSim
5
Ich möchte http://dillinger.io/ vorschlagen , einen weiteren wirklich coolen browserbasierten Texteditor. Außerdem können Sie Dropbox, Github und Google Drive verknüpfen.
— SirLisko
Der Notepad-Link in dieser Antwort löst einen RAR-Dateidownload aus. Warum gibt es keine Webseite, haben Sie nicht gesagt, dass es sich um einen browserbasierten Editor handelt?
— evanrmurphy
Dieser Link ist nicht mehr gültig
— Carlos Pliego
Ich möchte nur darauf hinweisen, dass dies keine vollständige Antwort auf die Frage ist. Sie erklären nicht, was .md ist, sondern nur, wie es bearbeitet werden kann
— Zoe
44

Der Atom-Texteditor von Github verfügt über einen Live-Vorschaumodus für Markdown-Dateien.

Die Tastenkombination ist CTRL+SHIFT+M.

Es kann aus dem Editor aktiviert wird die CTRL+SHIFT+MSchlüssel-Bindung und zur Zeit aktiviert ist für .markdown, .md, .mkd, .mkdown, und .ronDateien.

Geben Sie hier die Bildbeschreibung ein

— Feckmore
quelle
33

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) oder Shift+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) oder Cmd+K V(Mac).

Geben Sie hier die Bildbeschreibung ein

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.

— Feckmore
quelle
Wenn Sie stattdessen Visual Studio 2015 verwenden, lesen Sie meine Antwort unten.
— Bytedev
1
Hinweis - Sie können mit der rechten Maustaste auf die Readme-Datei klicken> Vorschau öffnen
— Chris Halcrow
15

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 .

— Codebrand
quelle
4
Eigentlich Sie wird es in Markdown - Format sehen. Sie werden es jedoch nicht als fett, kursiv, Einrückungen und Codeblöcke sehen.
— Leichtigkeitsrennen im Orbit
14

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.

— esilvas
quelle
5
Abgestimmt. Mit "eins" in "eins in Ihr Repository aufnehmen" sollten Sie "eine README-Datei in einem beliebigen Format" meinen, nicht nur "eine README.md-Datei". Die Frage bezieht sich jedoch auf ".md" -Dateien im Allgemeinen und nicht auf READMEs im Allgemeinen. Diese Antwort ist also für die Frage irrelevant. Die Mehrdeutigkeit mit „Eins“ könnte den Leser auch denken lassen, dass Markdown-READMEs notwendigerweise besser sind als andere READMEs, was falsch ist.
— Rory O'Kane
1
Ich habe die im vorherigen Kommentar angegebene Änderung vorgenommen, da sie sinnvoll ist und meiner Meinung nach dazu beitragen kann, Verwirrung zu vermeiden. Ich denke jedoch nicht, dass dies eine sehr gute Antwort ist, da sie nichts Neues hinzufügt, das relevant ist. Bei dieser Frage geht es nicht um READMEs, sondern um die Erweiterung .md. Es gibt keinen Grund, diese Antwort sechs Wochen nach der Annahme der gleichen Antwort hinzuzufügen.
— Erick Robertson
5

Stack Edit ist ein Online-Markdown-Editor, der in Google Drive und DropBox gespeichert werden kann.

— Philip
quelle
5

Markdown ist nur eine Textdatei, die optional .mdoder .markdownErweiterungen enthält. Es kann in HTML konvertiert werden. Informationen zur Syntax von Markdown finden Sie unter Auschecken

GitHub Flavored Markdown .

Sie können einen beliebigen Texteditor für das Markdown verwenden. Wenn Sie sublime textBenutzer 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

— Fizer Khan
quelle
3

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.

— Romeno
quelle
2

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.

— bytedev
quelle
0

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.

— richardwendrock
quelle
Dies funktioniert nur, wenn Sie ein Plugin haben, das MD-Dateien liest.
— Brad Bruce
0

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

— NocFenix
quelle
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.