Qual è la differenza tra README e README.md nei progetti GitHub?


387

Ho notato che alcuni progetti GitHub hanno non solo un READMEfile, ma anche un README.mdfile.

Qual è la differenza tra questi file? So che READMEserve anche come testo introduttivo nella pagina del repository del progetto, ma non ho idea di cosa README.mdfaccia.


3
Ho trovato molto utile questo rapido riferimento (cheatsheet) per il
markdown

Risposte:


381

.md è markdown. README.mdviene utilizzato per generare il htmlriepilogo visualizzato nella parte inferiore dei progetti. Github ha il suo sapore di Markdown .

Ordine di preferenza: se hai due file nominati READMEe README.md, il file denominato README.mdè preferito e verrà utilizzato per generare il htmlriepilogo di github .


FWIW, Stack Overflow utilizza anche le modifiche locali Markdown (vedi anche Processore Mark # C # Stack Overflow )



1
Eccellente elenco di funzioni di markdown
Sebastian Norr,

235

.md sta per markdown e viene generato nella parte inferiore della tua pagina github come html.

La sintassi tipica include:

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

Per maggiori dettagli: http://daringfireball.net/projects/markdown/


Riepilogo molto conciso.
Edward Falk,


23

README.mdo .mkdno .markdownindica che il file è formattato per il markdown . Markdown è un linguaggio di markup. Con esso puoi facilmente visualizzare le intestazioni o avere parole in corsivo, o grassetto o quasi tutto ciò che può essere fatto al testo

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.