GitHub projelerinde README ve README.md arasındaki fark nedir?


387

Bazı GitHub projelerinin sadece bir READMEdosya değil , aynı zamanda bir README.mddosya olduğunu fark ettim .

Bu dosyalar arasındaki fark nedir? READMEProje deposu sayfasında tanıtım metni olarak da hizmet verdiğini biliyorum ama ne yaptığına dair hiçbir fikrim README.mdyok.


3
Markdown için bu hızlı referansı (cheatsheet) çok kullanışlı buldum: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Ahmed

Yanıtlar:


381

.md markdown. projelerin altında gördüğünüz özeti README.mdoluşturmak için kullanılır html. Github'un kendi Markdown lezzeti vardır .

Tercih Sırası:README ve adında iki dosyanız varsa README.md, adında dosya README.mdtercih edilir ve github htmlözetini oluşturmak için kullanılır .


FWIW, Stack Overflow da yerel Markdown değişikliklerini kullanıyor (ayrıca Stack Overflow'un C # Markdown İşlemcisine de bakınız )




235

.md markdown anlamına gelir ve github sayfanızın altında html olarak oluşturulur.

Tipik sözdizimi şunları içerir:

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

Daha fazla ayrıntı için: http://daringfireball.net/projects/markdown/


Çok özlü bir özet.
Edward Falk


23

README.mdveya .mkdnveya .markdown, dosyanın markdown biçiminde olduğunu belirtir . Markdown bir biçimlendirme dilidir. Bununla birlikte, başlıkları kolayca görüntüleyebilir veya italik kelimelere veya kalın veya metne yapılabilecek neredeyse her şeye sahip olabilirsiniz.

Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.