web-dev-qa-db-fra.com

Extension de fichier pour les fichiers Markdown?

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

116
Beat Rupp

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, j’ai vu les .markdown et .mdown utilisés le plus souvent, et en tant qu’utilisateur Linux, j’éviterais d’utiliser .md, car cela peut aussi être un machine fichier de description pour la compilation de code avec GCC.


Exemples d'utilisation de l'extension:

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

Eléments Editeur de Markdown: markdown, mdown, mdwn, md

Vim markdown : markdown, mdown, mkdn, mdwn, mkd, md

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

R Studio : Rmd


Lectures complémentaires

Il existe une liste de diffusion Markdown qui propose 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 qui ouvre un fichier texte ne sera dérouté s’il trouve la syntaxe Markdown, c’est un pur bonus.

En ce sens, il est logique d'utiliser ".text", ".txt" ou toute autre extension en texte clair pertinente.
...
Un éditeur qui ignore tout de Markdown ne s’intéressera pas aux 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.

109
Cas

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 (.txt ou .text).

Cependant, certaines personnes utilisent .markdown ou .mdown.

16
vartec

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

3
Dennis Williamson

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

2
Subhash Chandran

Doxygen ajouté le support de Markdown dans la v1.8. Il recherche les extensions de fichier .md ou .markdown.

2
Andy Dent

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 celui-ci est actuellement développé et chargé sur le site de scripts vim de Hallison Batista et d'autres.

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

1
LeoR

Bref, la réponse est non.

Si vous utilisez simplement des fichiers de démarques en tant que fichiers autonomes qui ne seront aucunement traités, nommez-les comme vous le souhaitez. Si vous les utilisez dans un système et les traite au format HTML ou PDF ou dans un autre format, vous devez déterminer les extensions de fichier attendues par le système pour les 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.

1
Ryan Thompson

Hmm ... Geany, l'IDE open source, lors de l'enregistrement d'un fichier au format Markdown, utilise l'extension .mdml. Etrange qu'il semble être le seul ...

0
User203040