J’ai remarqué que certains projets GitHub ont non seulement un fichier README
, mais également un fichier README.md
.
Quelle est la différence entre ces fichiers? Je sais que 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 README.md
fait README.md
.
.md est un markdown
. README.md
est utilisé pour générer le résumé html
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
et README.md
, le fichier nommé README.md
est préférable et il sera utilisé pour générer le résumé html
de github.
FWIW, Stack Overflow utilise également les modifications de Markdown locales (voir également Processeur de décompte C # de Stack Overflow )
.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/
.md
extension .md
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:
README.md
ou .mkdn
ou .markdown
indique que le fichier est formaté en démarques . Markdown est un langage de balisage. Avec cela, vous pouvez facilement afficher des en-têtes ou des mots en italique, ou en gras ou presque tout ce qui peut être fait pour le texte