2011-12-28 33 views
326

Tôi đã nhận thấy một số dự án GitHub không chỉ có tệp README mà còn có tệp README.md.Sự khác biệt giữa README và README.md trong các dự án GitHub là gì?

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

+3

tôi tìm thấy thông tin này nhanh chóng (cheatsheet) cho markdown rất hữu ích: [https://github.com /adam-p/markdown-here/wiki/Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) –

Trả lời

331

.md là markdown. README.md được sử dụng để tạo ra tóm tắt html mà bạn nhìn thấy ở cuối các dự án. Github có their own flavor of Markdown.

thứ tự ưu tiên: Nếu bạn có hai tập tin có tên READMEREADME.md, các tập tin có tên README.md được ưa thích, và nó sẽ được sử dụng để tạo html tóm tắt github của.


FWIW, Stack Overflow uses local Markdown modifications as well (xem thêm Stack Overflow's C# Markdown Processor)

+4

Cập nhật github markdown https: //help.github. com/articles/github-flavored-markdown/ –

30

.md phần mở rộng là viết tắt của Markdown, mà Github sử dụng, trong số những người khác, để định dạng các tập tin.

đọc về Markdown:

http://daringfireball.net/projects/markdown/

http://en.wikipedia.org/wiki/Markdown

Ngoài ra:

http://github.github.com/github-flavored-markdown/

+2

+1 để liên kết đến trang của Github: http://github.github.com/github-flavored-markdown/ đặc biệt là '' 'cho các khối mã – AJP

17

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

202

.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 tiêu biểu 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://daringfireball.net/projects/markdown/

+3

Cũng thử dùng Mou, một trình soạn thảo markdown. http://mouapp.com – Foxinni

+0

Tóm tắt ngắn gọn. –

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