2011-12-16 18 views
10

Cargué un código en github con un archivo README.txt en formato ReStructuredText. ¿Hay alguna manera de indicarle a github que formatee este archivo como resto en lugar de simplemente texto?¿Hay alguna manera de forzar el formato de un archivo README.txt en github?

+0

No, que yo sepa, es necesario nombrar el archivo de la forma adecuada para que se rindió al igual que lo quiere instalar. – fge

+2

'README.md' para Markdown,' README.textile' para Textile, etc. –

Respuesta

13

El nombre del archivo debe terminar en rest, rst, rest.txt or rst.txt

https://github.com/github/markup

+3

El README solo documenta '.rst' pero el [código real] (https://github.com/github/markup/blob/1e7d83fd1e605db9f0d975482c2891a19bfeaf6b /lib/github/markups.rb#L33) coincide con '/ re? st (\. txt)? /'. La búsqueda de github muestra [README.rst] (https://github.com/search?p=100&q=filename%3AREADME.rst+extension%3Arst&ref=searchresults&type=Code&utf8=%E2%9C%93) es mucho más popular que [ README.rest] (https://github.com/search?p=18&q=filename%3AREADME.rest+extension%3Arest&ref=searchresults&type=Code&utf8=%E2%9C%93). –

Cuestiones relacionadas