Extension de fichier pour les fichiers Markdown?

116

Existe-t-il une extension de fichier officielle pour les fichiers Markdown autonomes?

Beat Rupp
la source
8
Est-ce que quelqu'un utilise filename.md.txtde la même manière que filename.rst.txt? Il indique qu'il s'agit du format markdown, mais qu'il revient également au texte brut si vous n'avez pas quelque chose à gérer. GitHub reconnaît .rst.txt, mais pas .md.txt: gist.github.com/2770487
endolith
1
Si vous envisagez de stocker ces fichiers sur une machine Windows, vous devez utiliser une extension <= 3 caractères. Cela fait .mdet .mkdles seules options couramment utilisées. De ceux .md- là est FAR plus populaire alors je suggère fortement d'utiliser cela. Ne vous inquiétez pas des fichiers descripteurs de machine; ils ne sont pas très utilisés et ils devraient être parfaitement modifiables dans un éditeur Markdown (il suffit d'ignorer la partie aperçu de l'éditeur).
Krowe2

Réponses:

109

Aucune extension de fichier Markdown n'est requise, comme d'autres réponses l'ont expliqué. Mais pour que les éditeurs ou les analyseurs syntaxiques puissent s’assurer que le fichier qu’ils utilisent est au format Markdown, ils rechercheraient l’une des extensions suivantes:

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

Certains sites Web, tels que GitHub, n'utilisent qu'une sélection de ces extensions pour la conversion au format HTML afin que les développeurs se conforment à leur norme. (voir exemples ci-dessous)

Personnellement, je l' ai vu .markdown et .mdown le plus utilisé, et en tant qu'utilisateur Linux j'éviter d' utiliser .md car cela peut aussi être un m achine d fichier escription pour la compilation du code avec GCC.


Exemples d'utilisation de l'extension:

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

Éléments Markdown Editor: markdown, mdown, mdwn, md

Vim markdown : démarque, mdown, mkdn, mdwn, mkd, md

Bitbucket : markdown, mdown, mkdn, mkd, md, text ( source )

R Studio : Rmd


Lectures complémentaires

Il y a une liste de diffusion Markdown avec des discussions intéressantes sur ce sujet: 1 , 2 .

Et surtout révélatrice est l'une des explications:

Markdown n'est pas destiné à reprendre le format d'un fichier, c'est un moyen d'ajouter de manière subtile des informations au texte en clair. En réalité, la présence de Markdown est une métadonnée et non un format de fichier.
...
Personne n'ouvrant un fichier texte ne sera confondu s'il trouve la syntaxe Markdown, c'est du pur bonus.

En ce sens, il est logique d'utiliser ".text", ".txt" ou toute autre extension en texte clair pertinente.
...
Un éditeur qui ne connaît rien à Markdown ne se souciera pas des métadonnées et ne sera pas dérouté par la variété d’extensions "non standard", mais affichera et modifiera le texte en clair sans problème.

Cas
la source
Bitbucket utilise md, mkdn, markdown: confluence.atlassian.com/display/BITBUCKET/…
Randy Syring
Les fichiers .md et .markdown semblent être les extensions les plus couramment utilisées à ce stade.
Christopher Barber
Petite mise à jour sur les extensions reconnues par GitHub, il semble que la liste se un peu: md, mkd, mkdn, mdwn, mdown, markdown- la source
Robert Audi
16

L'idée de MarkDown et de balises légères similaires doit être lisible en tant que texte brut; elles ont donc une extension text / plain ( .txtou .text).

Cependant, il y a des gens qui utilisent .markdownou .mdown.

vartec
la source
2
Pour la petite histoire, Elements pour iPhone reconnaît les formats .md, .markdown, .mdown, .mdwn et .text
Beat Rupp le
4
vim 7.3 reconnaît .markdown et .mdown, donc .markdown est le plus descriptif.
Martin Ueding
1
Kohana utilise .md
Liam Dawson le
3
J'ai aussi vu quelques fichiers .md dans GitHub, et mon Vim au bureau le reconnaît comme étant Markdown (je dois vérifier pourquoi cela ne se produit pas à la maison).
Wernight le
1
Cette réponse n’est pas aussi complète / complète que celle qui a recueilli le plus de votes.
svandragt
3

Je n'en connais pas, mais je pense qu'un précédent est créé par l'utilisation de l' .textextension sur le site officiel pour révéler le Markdown qui produit les pages.

Dennis Williamson
la source
3
Ce n'est pas parce que le site Web officiel l'utilise que c'est une bonne idée. .textsignifie texte brut, pas markdown.
endolith
2

iA Writer utilise l'extension .md pour le contenu Markdown.

Subhash Chandran
la source
2

Doxygen a ajouté le support de Markdown dans la version 1.8. Il cherche .mdou .markdowndes extensions de fichiers.

Andy Dent
la source
1

Bref, la réponse est non.

Si vous utilisez simplement des fichiers de démarques en tant que fichiers autonomes qui ne seront en aucun cas traités, nommez-les comme vous le souhaitez. Si vous les utilisez dans un système pour les traiter au format HTML, PDF ou autre, vous devez déterminer quelles extensions de fichier le système attend des fichiers de démarquage.

De plus, dans le contexte d’un système UNIX, les extensions de fichier ne sont même pas obligatoires. Vous pourriez simplement avoir un fichier appelé "README" au format Markdown.

Ryan Thompson
la source
Mais fileje vous dirai seulement que c'est du texte ASCII, ce qui ne me dit pas que je peux le parcourir markdown.
Martin Ueding
1

En plus de la très bonne réponse de Cas, je voudrais mentionner que son lien vers le référentiel github de Vim markdown est quelque peu obsolète.

L'utilisateur plasticboy était le créateur original de Vim Markdown mais il est actuellement développé et téléchargé sur le site de scripts vim par Hallison Batista et d'autres.

Par exemple, un utilisateur a créé un fork pour prendre en charge les liens Gollum.

LeoR
la source
0

Hmm ... Geany, l'EDI open source, utilise l' .mdmlextension pour enregistrer un fichier au format Markdown . Étrange qu'il semble être le seul ...

Utilisateur203040
la source