Apa perbedaan antara README dan README.md dalam proyek GitHub?


387

Saya perhatikan beberapa proyek GitHub tidak hanya memiliki READMEfile, tetapi juga README.mdfile.

Apa perbedaan antara file-file ini? Saya tahu READMEberfungsi juga sebagai teks pengantar di halaman repositori proyek tetapi saya tidak tahu apa README.md.


3
Saya menemukan referensi cepat ini (cheatsheet) untuk penurunan harga sangat berguna: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Ahmed Alnabhan

Jawaban:


381

.md adalah markdown. README.mddigunakan untuk menghasilkan htmlringkasan yang Anda lihat di bagian bawah proyek. Github memiliki rasa Markdown sendiri .

Urutan Preferensi: Jika Anda memiliki dua file bernama READMEdan README.md, nama file README.mdlebih disukai, dan itu akan digunakan untuk menghasilkan htmlringkasan github .


FWIW, Stack Overflow juga menggunakan modifikasi Markdown lokal (juga lihat C # Markdown Processor Stack Overflow )



1
Daftar fitur penurunan harga yang sangat baik: github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Sebastian Norr

235

.md singkatan dari penurunan harga dan dihasilkan di bagian bawah halaman github Anda sebagai html.

Sintaksis umumnya meliputi:

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

Untuk lebih jelasnya: http://daringfireball.net/projects/markdown/


Ringkasan yang sangat ringkas.
Edward Falk


23

README.mdatau .mkdnatau .markdownmenunjukkan bahwa file tersebut adalah format markdown . Penurunan harga adalah bahasa markup. Dengan itu Anda dapat dengan mudah menampilkan header atau memiliki kata-kata miring, atau tebal atau hampir semua hal yang dapat dilakukan pada teks

Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.