2011-12-28 15 views
326

He notado que algunos proyectos de GitHub tienen no solo un archivo README, sino también un archivo README.md.¿Cuál es la diferencia entre README y README.md en proyectos de GitHub?

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

+3

he encontrado esta referencia rápida (Cheatsheet) para markdown muy útil: [https://github.com /adam-p/markdown-here/wiki/Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) –

Respuesta

331

.md es markdown. README.md se utiliza para generar el resumen html que se ve en la parte inferior de los proyectos. Github tiene their own flavor of Markdown.

orden de preferencia: Si tiene dos archivos denominados README y README.md, se prefiere el archivo llamado README.md, y se utiliza para generar el resumen de github html.


Fwiw, desbordamiento de pila uses local Markdown modifications as well (también ver Stack Overflow's C# Markdown Processor)

+4

Actualizado github markdown https: //help.github. com/articles/github-flavored-markdown/ –

17

README.md o .mkdn o .markdown indica que el archivo es rebaja formateado. Markdown es un lenguaje de marcado. Con él puede mostrar fácilmente encabezados o palabras en cursiva, o en negrita o casi cualquier cosa que se pueda hacer al texto

202

.md significa rebaja y se genera en la parte inferior de su página github como html.

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/

+3

Pruebe también con Mou, un editor de rebajas. http://mouapp.com – Foxinni

+0

Resumen muy conciso. –

Cuestiones relacionadas