J'ai remarqué que certains projets GitHub ont non seulement un README
fichier, mais aussi un README.md
fichier.
Quelle est la différence entre ces fichiers? Je sais README
sert é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.md
passe.
Réponses:
.md l'est
markdown
.README.md
est utilisé pour générer lehtml
ré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
README
etREADME.md
, le fichier nomméREADME.md
est préféré, et il sera utilisé pour générer lehtml
résumé de github .FWIW, Stack Overflow utilise également les modifications locales de Markdown (voir également Processeur de Markdown C # de Stack Overflow )
la source
.md
signifie markdown et est généré au bas de votre page github en html.La syntaxe typique comprend:
Pour plus de détails: http://daringfireball.net/projects/markdown/
la source
.md
extension signifie Markdown, que Github utilise, entre autres, pour formater ces fichiers.Lisez à propos de Markdown:
http://daringfireball.net/projects/markdown/
http://en.wikipedia.org/wiki/Markdown
Aussi:
http://github.github.com/github-flavored-markdown/
la source
README.md
ou.mkdn
ou.markdown
indique 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 textela source