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

readme.md format

Question

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

¿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 lo que hace README.md .

Answer 1

.md es markdown . README.md se utiliza para generar el resumen html que se ve en la parte inferior de los proyectos. Github tiene su propio sabor de Markdown .

Orden de preferencia: si tiene dos archivos llamados README y README.md , se README.md el archivo llamado README.md , y se usará para generar el resumen html de github.

FWIW, también usa modificaciones locales de Markdown (también vea C # Markdown Processor )

Answer 2

.md extensión .md significa Markdown, que Github usa, entre otros, para formatear esos archivos.

Lea acerca de Markdown:

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

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

También:

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

Answer 3

.md significa markdown y se genera en la parte inferior de la 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/

Answer 4

README.md o .mkdn o .markdown denota que el archivo tiene formato de .mkdn .markdown . Markdown es un lenguaje de marcas. Con él, puede mostrar fácilmente los encabezados o tener palabras en cursiva, o negrita o casi cualquier cosa que se pueda hacer al texto.