Qual é a diferença entre o README e o README.md nos projetos do GitHub?


387

Notei que alguns projetos do GitHub não têm apenas um READMEarquivo, mas também um README.mdarquivo.

Qual é a diferença entre esses arquivos? Eu sei que READMEserve também como texto introdutório na página de repositório do projeto, mas não tenho ideia do que README.mdfaz.


3
Eu encontrei esta referência rápida (cheatsheet) para remarcação muito útil: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Ahmed Alnabhan

Respostas:


381

.md é markdown. README.mdé usado para gerar o htmlresumo que você vê na parte inferior dos projetos. O Github tem seu próprio sabor de Markdown .

Ordem de preferência: se você tiver dois arquivos nomeados READMEe README.md, o arquivo nomeado README.mdé o preferido e será usado para gerar o htmlresumo do github .


FWIW, o Stack Overflow também usa modificações locais do Markdown (consulte também Processador de Markdown C # do Stack Overflow )



11
Excelente lista de remarcação apresenta: github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Sebastian Norr

235

.md significa markdown e é gerado na parte inferior da página do github como html.

A sintaxe típica inclui:

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 mais detalhes: http://daringfireball.net/projects/markdown/


Resumo muito conciso.
Edward Falk


23

README.mdou .mkdnou .markdowndenota que o arquivo está formatado com descontos . Markdown é uma linguagem de marcação. Com ele, você pode exibir facilmente cabeçalhos ou ter palavras em itálico, negrito ou quase tudo o que pode ser feito no texto

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.