Sự khác biệt giữa README và README.md trong các dự án GitHub là gì?


387

Tôi đã nhận thấy một số dự án GitHub không chỉ có một READMEtệp mà còn có một README.mdtệp.

Sự khác biệt giữa các tập tin này là gì? Tôi biết READMEcũng phục vụ như văn bản giới thiệu trong trang kho dự án nhưng tôi không biết làm gì README.md.


3
Tôi thấy tài liệu tham khảo nhanh này (áo choàng) cho markdown rất hữu ích: https://github.com/adam-p/markdown-here/wiki/Markdown-Chcoateet
Ahmed Alnabhan

Câu trả lời:


381

.md là markdown. README.mdđược sử dụng để tạo ra htmlbản tóm tắt mà bạn nhìn thấy ở dưới cùng của dự án. Github có hương vị riêng của Markdown .

Thứ tự ưu tiên: Nếu bạn có hai tệp được đặt tên READMEREADME.md, tệp có tên README.mdđược ưu tiên và nó sẽ được sử dụng để tạo htmltóm tắt của github .


FWIW, Stack Overflow cũng sử dụng các sửa đổi Markdown cục bộ (cũng xem Bộ xử lý đánh dấu C # của Stack Overflow )



1
Danh sách tuyệt vời các tính năng đánh dấu: github.com/adam-p/markdown-here/wiki/Markdown-Chcoateet
Sebastian Norr

235

.md là viết tắt của markdown và được tạo ở cuối trang github của bạn dưới dạng html.

Cú pháp điển hình bao gồm:

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

Để biết thêm chi tiết: http://daredfireball.net/projects/markdown/


Tóm tắt rất súc tích.
Edward Falk


23

README.mdhoặc .mkdnhoặc .markdownbiểu thị rằng các tập tin được markdown định dạng. Markdown là một ngôn ngữ đánh dấu. Với nó, bạn có thể dễ dàng hiển thị các tiêu đề hoặc có các từ in nghiêng hoặc in đậm hoặc gần như bất cứ điều gì có thể được thực hiện để văn bản

Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.