¿Cuál es la diferencia entre README y README.md en proyectos de GitHub?

Resuelto Enrique Moreno Tent asked hace 12 años • 4 respuestas

He notado que algunos proyectos de GitHub no solo tienen un READMEarchivo, sino también un README.mdarchivo.

¿Cuál es la diferencia entre estos archivos? Sé que READMEtambién sirve como texto introductorio en la página del repositorio del proyecto, pero no tengo idea de qué README.mdsirve.

Enrique Moreno Tent avatar Dec 28 '11 19:12 Enrique Moreno Tent
Aceptado

.md es markdown. README.mdse utiliza para generar el htmlresumen que ve en la parte inferior de los proyectos. Github tiene su propia versión de Markdown .

Orden de preferencia: si tiene dos archivos con el nombre READMEy README.md, se prefiere el archivo con el nombre README.mdy se utilizará para generar el htmlresumen de github.


FWIW, Stack Overflow también usa modificaciones de Markdown locales (consulte también el procesador C# Markdown de Stack Overflow )

Mike Pennington avatar Dec 28 '2011 12:12 Mike Pennington

.mdsignifica markdown y se genera en la parte inferior de su página de github como html.

La sintaxis típica incluye:

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

Para más detalles: http://daringfireball.net/projects/markdown/

Foxinni avatar May 30 '2012 14:05 Foxinni

.mdLa extensión significa Markdown, que Github utiliza, entre otras cosas, para formatear esos archivos.

Lea sobre rebajas:

http://daringfireball.net/projects/markdown/

http://en.wikipedia.org/wiki/Markdown

También:

http://github.github.com/github-flavored-markdown/

Paul avatar Dec 28 '2011 12:12 Paul