Dateierweiterung für Markdown-Dateien?

116

Gibt es eine offizielle Dateierweiterung für eigenständige Markdown-Dateien?

file-extension markdown Beat Rupp
quelle
8
Verwendet jemand filename.md.txtauf die gleiche Weise wie filename.rst.txt? Es zeigt an, dass es sich um ein Markdown-Format handelt, greift jedoch auch auf einfachen Text zurück, wenn Sie mit Markdown nichts zu tun haben. GitHub erkennt .rst.txt, aber nicht .md.txt: gist.github.com/2770487
Endolith
1
Wenn Sie vorhaben, diese Dateien auf einem Windows-Computer zu speichern, würde ich bei einer Erweiterung von <= 3 Zeichen bleiben. Dies macht .mdund ist .mkddie einzige häufig verwendete Option. Davon .mdist VIEL beliebter, daher empfehle ich die Verwendung. Machen Sie sich keine Sorgen um die Deskriptordateien der Maschine. Sie sind nicht sehr verbreitet und sollten in einem Markdown-Editor perfekt bearbeitet werden können (ignorieren Sie einfach den Vorschauteil des Editors).
krowe2

Antworten:

109

Eine Markdown-Dateierweiterung ist nicht erforderlich, wie in anderen Antworten erläutert. Damit Editoren oder Parser jedoch sicherstellen können, dass die von ihnen verwendete Datei im Markdown-Format vorliegt, suchen sie nach einer der folgenden Erweiterungen:

.markdown
.mdown
.mkdn
.md
.mkd
.mdwn
.mdtxt
.mdtext
.text
.Rmd

Es gibt Websites wie GitHub, die nur eine Auswahl dieser Erweiterungen für die Konvertierung in HTML verwenden, damit Entwickler ihren Standards entsprechen. (siehe Beispiele unten)

Persönlich habe ich gesehen .markdown und .mdown verwendet , um die meisten, und als Linux - Benutzer würde ich vermeiden , mit .md wie dies kann auch sein , m achine d escription Datei für Code mit GCC kompilieren.

Beispiele für die Verwendung von Erweiterungen:

GitHub : markdown, mdown, mkdn, mkd, md ( Quelle )

Elemente Markdown - Editor: Abschlag, mdown, mdwn, md

Vim Markdown : Markdown, Mdown, Mkdn, Mdwn, Mkd, Md

Bitbucket : Markdown, Mdown, Mkdn, Mkd, Md, Text ( Quelle )

R Studio : Rmd

Weitere Lektüre

Es gibt eine Markdown-Mailingliste mit interessanten Diskussionen zu diesem Thema: 1 , 2 .

Und besonders aufschlussreich ist eine der Erklärungen:

Markdown soll nicht das Format einer Datei übernehmen, sondern dem Klartext auf subtile Weise Informationen hinzufügen. In Wirklichkeit handelt es sich bei Markdown um Metadaten und nicht um ein Dateiformat.
...
Niemand, der eine Textdatei öffnet, wird verwirrt sein, wenn er die Markdown-Syntax findet. Das ist ein reiner Bonus.

In diesem Sinne ist es sinnvoll, ".text", ".txt" oder eine andere relevante Klartext-Erweiterung zu verwenden.
...
Ein Editor, der nichts über Markdown weiß, kümmert sich nicht um die Metadaten und wird nicht durch die Vielzahl von "Nicht-Standard" -Erweiterungen verwirrt, sondern zeigt und bearbeitet den Klartext einwandfrei.

Cas
quelle
Bitbucket benutzt md, mkdn, markdown: confluence.atlassian.com/display/BITBUCKET/…
Randy Syring
.md und .markdown scheinen die derzeit am häufigsten verwendeten Erweiterungen zu sein.
Christopher Barber
Kleines Update auf den von GitHub erkannt Erweiterungen, wie es scheint die Liste ein wenig gewachsen: md, mkd, mkdn, mdwn, mdown, markdown- Quelle
Robert Audi
16

Die Idee von MarkDown und ähnlichen leichtgewichtigen Markups ist, dass sie als einfacher Text lesbar sind, also Text / einfache Erweiterung ( .txtoder .text) haben.

Es gibt jedoch einige Leute, die .markdownoder verwenden .mdown.

vartec
quelle
2
Nur zur Veranschaulichung: Elements for the iPhone erkennt .md, .markdown, .mdown, .mdwn und .text
Beat Rupp
4
vim 7.3 erkennt .markdown und .mdown, daher ist .markdown am aussagekräftigsten.
Martin Ueding
1
Kohana verwendet .md
Liam Dawson
3
Ich habe auch ein paar .md in GitHub gesehen und mein Vim im Büro erkennt es als Markdown (ich muss nachsehen, warum es nicht zu Hause ist).
Wernight
1
Diese Antwort ist nicht so umfassend / vollständig wie die mit den meisten Stimmen.
Svandragt
3

Mir ist keiner bekannt, aber ich denke, ein Präzedenzfall wird durch die Verwendung der .textErweiterung auf der offiziellen Website geschaffen , um den Markdown zu enthüllen , der die Seiten produziert.

Dennis Williamson
quelle
3
Nur weil die offizielle Website es benutzt, heißt das noch lange nicht, dass es eine gute Idee ist. .textbedeutet Klartext, kein Abschlag.
Endolith
2

iA Writer verwendet die Erweiterung .md für Markdown-Inhalte.

Subhash Chandran
quelle
2

Doxygen hat Markdown-Unterstützung in v1.8 hinzugefügt. Es sucht .mdoder .markdownDateierweiterungen.

Andy Dent
quelle
1

Kurz gesagt, die Antwort lautet nein.

Wenn Sie Markdown-Dateien einfach als eigenständige Dateien verwenden, die in keiner Weise verarbeitet werden, benennen Sie sie nach Belieben. Wenn Sie sie in einem System verwenden, das sie in HTML, PDF oder ein anderes Format verarbeitet, müssen Sie herausfinden, welche Dateierweiterungen das System für Markdown-Dateien erwartet.

Im Kontext eines UNIX-Systems sind Dateierweiterungen nicht einmal obligatorisch. Sie könnten einfach eine Datei mit dem Namen "README" im Abschriftenformat haben.

Ryan Thompson
quelle
Aber filewerde dir nur sagen, dass es sich um ASCII-Text handelt, der mir nicht sagt , dass ich ihn durchlaufen kann markdown.
Martin Ueding
1

Als Ergänzung zu Cas 'sehr guter Antwort möchte ich erwähnen, dass sein Link zum Github-Repository von Vim markdown etwas veraltet ist.

Der Benutzer plasticboy war der ursprüngliche Schöpfer von Vim Markdown, wird jedoch derzeit von Hallison Batista und anderen entwickelt und auf die Website für Vim-Skripte hochgeladen .

Zum Beispiel hat ein Benutzer einen Fork erstellt , um Gollum-Links zu unterstützen.

LeoR
quelle
0

Hmm ... Geany, die Open-Source-IDE, verwendet beim Speichern einer mit Markdown formatierten Datei die .mdmlErweiterung. Seltsam, dass es der einzige zu sein scheint ...

User203040
quelle