2011-12-16 10 views
10

Tôi đã tải lên một số mã để github bằng một tệp README.txt có định dạng ReStructuredText. Có cách nào để hướng dẫn github định dạng tệp này là phần còn lại thay vì chỉ văn bản thuần túy không?Có cách nào để buộc định dạng tệp README.txt trên github không?

+0

Không mà tôi biết, bạn cần phải đặt tên cho tập tin một cách thích hợp để nó được trả lại như bạn có ý định nó. – fge

+2

'README.md' cho Đánh dấu,' README.textile' cho Dệt may, v.v. –

Trả lời

13

Tên tập tin nên kết thúc ở rest, rst, rest.txt or rst.txt

https://github.com/github/markup

+3

README chỉ có tài liệu '.stst' nhưng [mã thực tế] (https://github.com/github/markup/blob/1e7d83fd1e605db9f0d975482c2891a19bfeaf6b /lib/github/markups.rb#L33) khớp với '/ re? st (\. txt)? /'. Tìm kiếm github hiển thị [README.rst] (https://github.com/search?p=100&q=filename%3AREADME.rst+extension%3Arst&ref=searchresults&type=Code&utf8=%E2%9C%93) phổ biến hơn [ README.rest] (https://github.com/search?p=18&q=filename%3AREADME.rest+extension%3Arest&ref=searchresults&type=Code&utf8=%E2%9C%93). –

Các vấn đề liên quan