¿Cuál es la diferencia entre README y README.md en proyectos de GitHub?
He notado que algunos proyectos de GitHub no solo tienen un README
archivo, sino también un README.md
archivo.
¿Cuál es la diferencia entre estos archivos? Sé que README
también sirve como texto introductorio en la página del repositorio del proyecto, pero no tengo idea de qué README.md
sirve.
.md es markdown
. README.md
se utiliza para generar el html
resumen 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 README
y README.md
, se prefiere el archivo con el nombre README.md
y se utilizará para generar el html
resumen de github.
FWIW, Stack Overflow también usa modificaciones de Markdown locales (consulte también el procesador C# Markdown de Stack Overflow )
.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/
.md
La 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/