2011-12-16 8 views
10

Ho caricato del codice su github con un file README.txt in formato ReStructuredText. C'è un modo per istruire github per formattare questo file come resto invece di solo testo?C'è un modo per forzare il formato di un file README.txt su github?

+0

Non che io sappia, è necessario un nome al file il modo appropriato in modo che essere reso come si intende a. – fge

+2

'README.md' per Markdown,' README.textile' per Textile, ecc. –

risposta

13

Il nome del file deve terminare con rest, rst, rest.txt or rst.txt

https://github.com/github/markup

+3

Il README contiene solo '.rst' ma il [codice effettivo] (https://github.com/github/markup/blob/1e7d83fd1e605db9f0d975482c2891a19bfeaf6b /lib/github/markups.rb#L33) corrisponde a '/ re? st (\. txt)? /'. La ricerca di github mostra [README.rst] (https://github.com/search?p=100&q=filename%3AREADME.rst+extension%3Arst&ref=searchresults&type=Code&utf8=%E2%9C%93) è molto più popolare di [ README.rest] (https://github.com/search?p=18&q=filename%3AREADME.rest+extension%3Arest&ref=searchresults&type=Code&utf8=%E2%9C%93). –

Problemi correlati