2011-12-16 14 views
10

Przesłałem kod do github z plikiem README.txt w formacie ReStructuredText. Czy istnieje sposób, aby polecić githubowi sformatowanie tego pliku jako reszta zamiast zwykłego tekstu?Czy istnieje sposób na wymuszenie formatu pliku README.txt na github?

+0

że nie wiem, trzeba nazwę pliku odpowiedni sposób, tak aby być renderowane jak masz zamiar go. – fge

+2

'README.md dla Markdown,' README.textile' dla Textile, itp. –

Odpowiedz

13

Nazwa pliku powinna zakończyć się w rest, rst, rest.txt or rst.txt

https://github.com/github/markup

+3

README tam tylko dokumentuje '.rst', ale [rzeczywisty kod] (https://github.com/github/markup/blob/1e7d83fd1e605db9f0d975482c2891a19bfeaf6b /lib/github/markups.rb#L33) dopasowuje '/ re? st (\. txt)? /'. Wyszukiwanie programów github [README.rst] (https://github.com/search?p=100&q=filename%3AREADME.rst+extension%3Arst&ref=searchresults&type=Code&utf8=%E2%9C%93) jest znacznie bardziej popularne niż [ README.rest] (https://github.com/search?p=18&q=filename%3AREADME.rest+extension%3Arest&ref=searchresults&type=Code&utf8=%E2%9C%93). –

Powiązane problemy