Github'da “markdown formatlı” bir README dosyası nedir?

27

Formatın ne olduğu açık değil, eğer oluşturmak için sistematik / komut satırı gereksinimleri varsa, vs.

Temel olarak, sadece özellikleri bilmek ve README dosyasını oluşturmak için teknik adımlar varsa gerek.

github

— gaflar
kaynak

4

Hayır, yalnızca el ile düzenlediğiniz bir metin dosyası. Sözdizimine gelince, en.wikipedia.org/wiki/Markdown

— Andrea

3

bu tarafın kullandığı wiki-edit-formatı ile aynıdır.

— k3b

+1 @Andrea: Teşekkürler, Github'da hangi format ve sürümün beklendiği hakkında bir avuç daha fazla markdown formatı düşünebiliyorum. Ayrıca, yorumunuz bir cevap olarak okunur, lütfen cevap olarak cevaplayın. Tekrar, teşekkürler!

— gaflar

+1 @ K3b: Bir şeye inandığına inan, Github'ın Gollum'u kullanmasından mı bahsediyorsun , örneğin göreceli bağlantıya izin veriyor? Eğer öyleyse, lütfen doğru cevap olduğuna inanıyorum. Teşekkürler!

— gaflar

37

Markdown, anlamsal bilgi sağlamak ve düz metinde ortak formatlamayı temsil etmek için basit bir sözdizimidir. Daring Fireball standart etiketleme için harika bir sözdizimi rehberine sahiptir . GitHub daha sonra GitHub Flavored Markdown adını verdikleri bir değişkeni kullanır .

Benioku ayarlarınızı yapmak için sadece düz bir metin dosyası oluşturun ve README (veya README.md / README.markdown) olarak adlandırın ve bunu reponuzun köküne çevirin. GitHub daha sonra bunu proje benioku olarak alır.

— Kim Burgess
kaynak

2

Ayrıca Markdown'ın nasıl kullanılacağını açıklayan bir video da hazırladım. Burada bulabilirsiniz: mikemclin.net/markdown-syntax-language

— Mike McLin

9

Wikipedia - Markdown , "GitHub Flavored Markdown - Giriş" sayfasına başvuruyor ( arşiv )

Sayfadan alıntı:

GitHub, mesajlar, sorunlar ve yorumlar için "GitHub Flavored Markdown" (GFM) olarak adlandırdığımız şeyi kullanır. Standart Markdown'dan (SM) birkaç önemli şekilde farklılaşır ve bazı ek işlevsellikler ekler.

Sayfa ayrıca standart Markdown ile olan farklarının bir tanımını verir.

Markdown'ın GitHub tarafından gerçekte nasıl oluşturulduğu hakkında daha fazla bilgi var:

Markdown dosyalarını nasıl oluşturduğumuzla ilgileniyorsanız , Sundown kütüphanesinin Ruby arayüzü olan Redcarpet'i incelemek isteyebilirsiniz .

(Görünüşe göre, Sundown perdelerin arkasında kullanılan gerçek Markdown ayrıştırıcısıdır.)

Bir başka soyutlama katmanı daha eklemek için Sundown, başka bir Markdown ayrıştırıcısının bir çatalıdır :-) Sundown's GitHub sayfasından
alıntı :

Sundown, Natacha Porté'nin Upskirt kütüphanesinin orijinal koduna dayanan bir Markdown ayrıştırıcısıdır .

— Hıristiyan Specht
kaynak

1

Çok garip ama GitHub kullanmaz sanki görünüyor GitHub Aromalı Markdown (GFM) bir README dosyasını işlerken.

GitHub, sitedeki "GitHub Flavored Markdown" veya GFM'i kullanıyor - sorunlar, yorumlar ve çekme istekleri.

Bunun yerine GitHub biçimlendirme projesinin bir parçası olarak redcarpet adlı bir sürüm kullanıyor gibi görünüyor . Ayrıca MediaWiki de dahil olmak üzere diğer birçok biçimlendirme formatını da destekliyorlar. Sadece doğru dosya uzantısını kullanın; GitHub işaretlemeyi oluşturacaktır.

Markdown'un iki farklı tadı arasındaki farkları görmek istiyorsanız, GFM'nin açıklamasını ve ek özelliklerini okuyun .

— Don Kirkby
kaynak

1

redcarpet ve Github Flavored Markdown, aynı şeydeki uygulamalarla rekabet etmeyen iki ayrı, ancak tamamlayıcı kavramdır. redcarpet temel olarak Github Flavored Markdown dilinde yazılmış ve HTML veya XHTML çıktılarını veren bir derleyicidir .

— 8,