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

387

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 lo que README.mdhace.

github markdown Tienda Enrique Moreno
fuente
3
Encontré esta referencia rápida (hoja de referencia) para markdown muy útil: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Ahmed Alnabhan

Respuestas:

381

.md es markdown. README.mdse utiliza para generar el htmlresumen que ve al final de los proyectos. Github tiene su propio sabor de Markdown .

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

FWIW, Stack Overflow también utiliza modificaciones de Markdown locales (también vea el Procesador de Markdown C # de Stack Overflow )

Mike Pennington
fuente
55
Actualizado github rebaja help.github.com/articles/github-flavored-markdown
Paul Gregoire
1
Excelente lista de características de descuento: github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Sebastian Norr
235

.md significa 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
fuente
Resumen muy conciso.
Edward Falk
23

README.mdo .mkdno .markdownindica que el archivo tiene formato de descuento . Markdown es un lenguaje de marcado. Con él, puede mostrar fácilmente encabezados o palabras en cursiva, o negrita o casi cualquier cosa que se pueda hacer para enviar mensajes de texto.

c00kiemon5ter
fuente