Quelle est la différence entre README et README.md dans les projets GitHub?


387

J'ai remarqué que certains projets GitHub ont non seulement un READMEfichier, mais aussi un README.mdfichier.

Quelle est la différence entre ces fichiers? Je sais READMEsert également de texte d'introduction dans la page du référentiel de projet, mais je n'ai aucune idée de ce qui se README.mdpasse.


3
J'ai trouvé cette référence rapide (cheatsheet) pour le démarquage très utile: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Ahmed Alnabhan

Réponses:


381

.md l'est markdown. README.mdest utilisé pour générer le htmlrésumé que vous voyez au bas des projets. Github a sa propre saveur de Markdown .

Ordre de préférence: si vous avez deux fichiers nommés READMEet README.md, le fichier nommé README.mdest préféré, et il sera utilisé pour générer le htmlrésumé de github .


FWIW, Stack Overflow utilise également les modifications locales de Markdown (voir également Processeur de Markdown C # de Stack Overflow )



1
Excellente liste de fonctionnalités de démarque: github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Sebastian Norr

235

.md signifie markdown et est généré au bas de votre page github en html.

La syntaxe typique comprend:

Will become a heading
==============

Will become a sub heading
--------------

*This will be Italic*

**This will be Bold**

- This will be a list item
- This will be a list item

    Add a indent and this will end up as code

Pour plus de détails: http://daringfireball.net/projects/markdown/


Résumé très concis.
Edward Falk


23

README.mdou .mkdnou .markdownindique que le fichier est formaté avec une démarque . Markdown est un langage de balisage. Avec lui, vous pouvez facilement afficher les en-têtes ou avoir des mots en italique, ou en gras ou presque tout ce qui peut être fait pour le texte

En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.