ความแตกต่างระหว่าง README และ README.md ในโครงการ GitHub คืออะไร?

387

ฉันสังเกตว่าโครงการ GitHub บางโครงการไม่เพียง แต่มีREADMEไฟล์ แต่ยังเป็นREADME.mdไฟล์ด้วย

ความแตกต่างระหว่างไฟล์เหล่านี้คืออะไร? ฉันรู้ว่าREADMEยังทำหน้าที่เป็นข้อความเกริ่นนำในหน้าที่เก็บโครงการ แต่ฉันไม่รู้ว่าREADME.mdมันทำอะไร

github markdown

— Enrique Moreno Tent
แหล่งที่มา

3

ฉันพบการอ้างอิงอย่างรวดเร็ว (cheatsheet) สำหรับ markdown มีประโยชน์มาก: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

— Ahmed Alnabhan

381

.md markdownคือ README.mdใช้เพื่อสร้างการhtmlสรุปที่คุณเห็นที่ด้านล่างของโครงการ Github มีรสชาติของตัวเอง Markdown

คำสั่งของการตั้งค่า:หากคุณมีสองไฟล์ชื่อREADMEและREADME.mdไฟล์ที่มีชื่อREADME.mdเป็นที่ต้องการและจะใช้ในการสร้างhtmlบทสรุปของ Github

FWIW, Stack Overflow ใช้การแก้ไข Markdown ในเครื่องด้วย (ดูที่C # Markdown Processor ของ Stack Overflow )

— ไมค์เพนนิงตัน
แหล่งที่มา

5

อัปเดต github markdown help.github.com/articles/github-flavoured-markdown

— Paul Gregoire

1

รายการยอดเยี่ยมของคุณสมบัติการมาร์คดาวน์: github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

— เซบาสเตียนนอร์

235

.md ย่อมาจาก markdown และสร้างที่ด้านล่างของหน้า Github ของคุณเป็น html

ไวยากรณ์ทั่วไปรวมถึง:

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

สำหรับรายละเอียดเพิ่มเติม: http://daringfireball.net/projects/markdown/

— Foxinni
แหล่งที่มา

สรุปรวบรัดมาก

— Edward Falk

37

.md ส่วนขยายย่อมาจาก Markdown ซึ่ง Github ใช้ในการจัดรูปแบบไฟล์เหล่านั้น

อ่านเกี่ยวกับ Markdown:

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

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

นอกจากนี้:

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

— พอล
แหล่งที่มา

4

+1 สำหรับลิงก์ไปยังหน้าของ Github: github.github.com/github-flavored-markdown โดยเฉพาะ `` `สำหรับบล็อคโค้ด

— AJP

23

README.mdหรือ.mkdnหรือ.markdownหมายถึงว่าไฟล์จะถูกmarkdownจัดรูปแบบ Markdown เป็นภาษามาร์กอัป ด้วยคุณสามารถแสดงส่วนหัวหรือมีคำตัวเอียงหรือตัวหนาหรือเกือบทุกอย่างที่สามารถทำกับข้อความ

— c00kiemon5ter
แหล่งที่มา