GitHub ve Reddit'te Markdown'ı hızlıca nasıl kullanabilirsiniz?

Informatec Dijital » Ücretsiz Destekler » GitHub ve Reddit'te Markdown'ı hızlıca nasıl kullanabilirsiniz?

GitHub'da sık sık yazı yazıyorsanız veya Reddit'te çok zaman geçiriyorsanız, Markdown'ı öğrenmek size saatler kazandıracak ve hayatınızı kolaylaştıracak şeylerden biridir. Menüler veya düğmelerle uğraşmadan, sadece birkaç sembolü doğru yerlere yerleştirerek düz metni hızlıca biçimlendirmenizi sağlayan çok hafif bir işaretleme dilidir.

GitHub'da her yerde karşınıza çıkar: depo README.md dosyalarında , sorunlarda, çekme isteklerinde, tartışmalarda ve hatta kendi profilinizde. Reddit ise, GitHub'ın sözdiziminin büyük bir kısmını miras alan, ancak bazı benzersiz özelliklere ve sınırlamalara sahip Snoomark (Reddit tarzı Markdown) adı verilen bir varyant kullanır. Gelin, adım adım ve bol örneklerle, GitHub ve Reddit'te Markdown'ı hızlı ve önemli hiçbir şeyi atlamadan nasıl kullanacağımızı görelim.

Markdown nedir ve GitHub ve Reddit'te neden bu kadar kullanışlıdır?

Markdown, düz metni okumayı ve yazmayı kolaylaştırmak ve aynı zamanda HTML'ye zahmetsizce dönüştürmeye olanak sağlamak için tasarlanmış hafif bir işaretleme dilidir . Pratikte bu, normal metin yazabileceğiniz ve başlıklar, listeler, tablolar, alıntılar, biçimlendirilmiş kod, bağlantılar veya resimler oluşturmak için birkaç özel karakter ekleyebileceğiniz anlamına gelir.

GitHub'da kullanılan uygulama, klasik sözdizimini tablolar, yapılacaklar listeleri, gelişmiş kod vurgulama, renk desteği, uyarılar ve bazı izin verilen HTML etiketleriyle genişleten GitHub Flavored Markdown (GFM)'dir. Tüm bunlar .md dosyalarında ve platformun yorum alanlarında otomatik olarak oluşturulur .

Reddit, GFM'nin bir türevi olan Snoomark adlı kendi editörünü kullanıyor. Temel işlevlerin çoğunu (kalın, italik, başlıklar, listeler, alıntılar, satır içi veya blok kod, bağlantılar vb.) paylaşıyor, ancak önemli özelliklere sahip : örneğin, bağlama bağlı olarak resim desteği daha sınırlı ve spoiler gibi kendi öğelerini ekliyor.

Tüm bunların güzelliği, tek bir söz dizimiyle hem GitHub'da hem de Reddit'te iyi görünecek metinler yazabilmeniz ve her platformun farklı çalıştığı birkaç ayrıntıyı uyarlamanız yeterli olmasıdır. Temel kuralları öğrenmek, her ikisinde de hiçbir şeyi sıfırdan yeniden öğrenmek zorunda kalmadan kolaylıkla gezinmenizi sağlar.

Başlıklar ve içerik yapısı

GitHub ve Reddit'te kullanacağınız ilk şeylerden biri başlıklar olacaktır . Bunlar metni bölümlere ve alt bölümlere ayırmaya yardımcı olur.

Markdown'da, bir başlık, metnin başına bir ila altı arasında '#' sembolü eklenerek oluşturulur: 1. seviye başlık için bir, 2. seviye için iki ve bu şekilde 6. seviyeye kadar devam eder. Örneğin, bir GitHub README.md dosyasında şöyle bir şey olabilir: # Ana Başlık , ## Bölüm , ### Alt Bölüm , vb.

GitHub, bir dosyada iki veya daha fazla başlık bulduğunda, dosyanın üst kısmındaki "Anahat" simgesinden erişilebilen bir içindekiler tablosu otomatik olarak oluşturur. Her başlık, sizi doğrudan o bölüme götüren bir bağlantı olarak görünür; bu da uzun belgeler için harika bir özelliktir.

Ayrıca, her başlık, başlık metnine dayalı bir URL parçacığıyla bağlantı kurabileceğiniz dahili bir bağlantı noktası haline gelir. Bu parçacığı oluşturmak için GitHub çok özel kurallar uygular: harfleri küçük harfe dönüştürür, boşlukları tirelerle değiştirir, noktalama işaretlerini ve biçimlendirme karakterlerini (italik gibi) kaldırır, fazla boşlukları kırpar ve sonuç önceki bir başlıkla eşleşirse, onu benzersiz kılmak için sayısal bir sonek (-1, -2, vb.) ekler.

Bu, örneğin bir ## Örnek Bölüm ekleyip , belgenin başka bir noktasından (#örnek-bölüm) gibi bir bağlantı ile ona bağlantı vermenize veya başlığında özel karakterler bulunan bölümlere bile bağlantı vermenize olanak tanır, çünkü GitHub bu kurallara göre kod parçasını oluşturur ve aynı kalıpla erişilebilir hale getirir.

Vurgu, öne çıkarılmış metin ve alıntılar

Markdown, kalın, italik, üstü çizili, alt simge, üst simge veya alt çizgi gibi çeşitli vurgulama biçimleri kullanarak metni vurgulamanıza olanak tanır . GitHub'da tipik bir stil tablosu şöyle görünür, ancak burada farklı terimlerle özetledik:

Metni kalın yapmak için çift yıldız veya çift alt çizgi kullanın; italik için tek yıldız veya alt çizgi kullanın; üstü çizili yapmak için metnin her iki tarafına çift tilde (iki tilde) koyun. Ayrıca iç içe kalın ve italik yazı tiplerini birleştirebilir, metnin tamamına her ikisini de uygulamak için üç yıldız kullanabilir veya alt simge ve üst simge _{için `<b>` ^{ve alt çizgi için `<i>` gibi HTML etiketleri kullanabilirsiniz.}}

GitHub ayrıca, satırın başına büyüktür sembolü (>) koyarak blok alıntılar oluşturmanıza olanak tanır . Alıntılanan metin, solunda dikey bir çubukla ve gri renkte görüntülenir, bu da onu net bir şekilde öne çıkarır. Aynı blok alıntı içinde birden fazla satır olabilir ve hatta başına daha fazla > sembolü ekleyerek alıntıları iç içe yerleştirebilirsiniz.

GitHub'a özgü gelişmiş bir alıntı biçimi de uyarı veya ikazdır . Aynı blok alıntı sözdizimini kullanır, ancak ilk satırda uyarı türünü belirtmek için özel bir işaretleyici bulunur. Örneğin, yararlı bilgiler için `alert`, `yardımcı ipuçları`, `anahtar veriler`, `acil uyarılar` ve `risk veya olumsuz sonuçlarla ilgili uyarılar` belirtebilirsiniz. GitHub, her türü farklı bir renk ve simgeyle göstererek dokümanlarınızdaki kritik bilgileri vurgulamaya yardımcı olur.

Reddit, GitHub'ın zengin ping sistemine sahip olmasa da, aynı > sembolüyle basit alıntıları da destekliyor. Yine de, birinin mesajının bir kısmını tamamen tekrarlamadan alıntılayarak yanıt vermenin çok kullanışlı bir yolu olmaya devam ediyor.

Kod vurgulama, bloklar ve renkler

GitHub ve Reddit'in her ikisi de metin içindeki kod parçacıklarını ters tırnak işaretleri kullanarak vurgulamanıza olanak tanır. Satır içi kod için, kelimeyi veya komutu her iki tarafa tek bir ters tırnak işaretiyle çevrelersiniz. Bu, örneğin bir cümle içindeki ` git status` ifadesini vurgulamak ve bunun bir komut olduğunu açıkça belirtmek için idealdir.

Bağımsız bir kod bloğu istediğinizde, Markdown üç ters tırnak işareti kullanır: üç ters tırnak işaretiyle bir satır yazarsınız, ardından kodu ayrı satırlara yazarsınız ve son olarak üç ters tırnak işaretiyle bitirirsiniz. GitHub'da, ilk ters tırnak işaretlerinden hemen sonra dili de belirtirseniz, o dile özgü renkler ve biçimlendirme ile sözdizimi vurgulaması uygulanır.

GitHub ayrıca, ters tırnak işaretleri içindeki renk değerlerini vurgulamak için özel bir özellik sunar . Ters tırnak işaretleri arasına onaltılık, RGB veya HSL formatında bir renk yazarsanız, platform metnin yanına küçük bir renk göstergesi ekler. Örneğin, açık modda arka plan rengi #ffffff ve koyu modda #000000 ise, bu kodları vurgulamak hangisinin hangisi olduğunu hızlıca görmenizi sağlar.

Kod ve tablo gösterimiyle ilgili olarak, GitHub tüm yorum alanlarında sabit tek aralıklı bir yazı tipini etkinleştirmenize olanak tanıyarak teknik metinlerle çalışmayı kolaylaştırır. Tarayıcınızda veya Visual Studio Code gibi editörlerde çok sayıda kod parçacığı düzenliyorsanız , bu seçeneği etkinleştirmek hizalamayı ve okunabilirliği çok daha tutarlı hale getirir.

Reddit ayrıca, satır içi ve blok halinde, ters tırnak işaretli kod bloklarını da destekler; ancak bunların kullanımı burada daha çok küçük kod parçacıkları veya sözde kodlar için geçerlidir, bir depodaki gibi uzun dokümanlar için değil.

Bağlantılar, çapalar ve dahili gezinme

Markdown'da bağlantı oluşturmak çok basittir: Kullanıcıya gösterilecek metni köşeli parantez içine, URL'yi ise parantez içine alırsınız. Bu yöntem hem GitHub hem de Reddit'te çalışır ve GitHub'da klavye kısayollarıyla (örneğin, seçili metni hızlıca bağlantıya dönüştürmek için tuş kombinasyonları kullanarak) geliştirilebilir.

GitHub, gezinmeyle ilgili bazı ek özellikler sunuyor. İlk olarak, daha önce ele alınan kod parçacığı oluşturma kurallarını kullanarak başlıklara doğrudan bağlantı vermenize olanak tanıyor . İkincisi, teknik dokümantasyon için çok önemli olan, depo içinde göreceli bağlantıları destekliyor.

Göreceli bağlantı, geçerli dosya referans alınarak hesaplanan bir bağlantıdır. Örneğin, README dosyanız proje kök dizinindeyse ve docs/CONTRIBUTING.md dosyasına bağlantı vermek istiyorsanız, docs/CONTRIBUTING.md yoluyla bir bağlantı yazmanız yeterlidir. GitHub, bu göreceli bağlantıyı hangi dalda olursanız olun doğru şekilde çevirir ve dallar arasında geçiş yaparken veya depoyu klonlarken bozulmasını önler.

Aynı depodaki dosyalar arasında gezinirken her zaman göreceli yollar kullanılması önerilir , çünkü mutlak bağlantılar klonlarda veya çatallarda çalışmayı durdurabilir. GitHub, ./ veya ../ gibi standart operatörlerin ve proje köküne göre / ile başlayan yolların kullanımına izin verir.

Belge içinde başlıkların ötesinde özel bağlantı noktaları oluşturmak istiyorsanız, `name` özniteliğine sahip HTML etiketlerini kullanabilirsiniz. Bu, bir hedef noktayı bir paragrafın ortasına veya kendi başlığı olmayan metnin yanına yerleştirmenize ve otomatik olarak oluşturulan başlıklarla aynı sözdizimini kullanarak ona bağlantı vermenize olanak tanır.

GitHub'daki görseller: Markdown, HTML ve göreceli yollar

GitHub'da görseller genellikle bağlantılarla aynı sözdizimi kullanılarak, ancak ünlem işaretiyle başlayarak yerleştirilir. Alternatif metin (alt) köşeli parantezler içinde belirtilir ve görselin URL'si veya yolu parantez içine yerleştirilir. Bu alternatif metin erişilebilirlik açısından önemlidir , çünkü ekran okuyucuların okuyacağı ve görsel yüklenemediğinde görüntülenecek olan metin budur.

Görseller, depodaki dosyalardan veya harici URL'lerden gelebilir. GitHub, farklı dallardan, diğer depolardan veya hatta sorunlardan ve yorumlardan görsel yüklemek için birden fazla göreceli yol kalıbına izin verir ve gerektiğinde doğrudan dosya indirmeyi zorlamak için ?raw=true gibi son ekler kullanır.

GitHub, standart Markdown sözdizimine ek olarak HTML `<picture>` öğesinin kullanımını da destekler. Bu öğe, kullanıcının tema tercihlerine (açık veya koyu) göre değişen duyarlı görselleri yüklemek için özellikle kullanışlıdır . `prefers-color-scheme` medya sorgusunu kullanarak, her mod için farklı resim kaynakları ve bu özelliği desteklemeyen tarayıcılar için varsayılan bir resim tanımlayabilirsiniz.

Tipik model, aşağıdakileri içermeyi içerir: birkaç unsur medya ve srcset öznitelikleriyle ve son olarak bir Alt özniteliğini ve genel bir URL'yi kullanarak, karanlık moddaki kullanıcılar uyarlanmış bir resim görürken, açık moddaki kullanıcılar README dosyasındaki içeriği tekrarlamaya gerek kalmadan farklı bir resim görür.

GitHub, Markdown dosyalarında HTML yorumlarını da destekleyerek okuyucuya görünmez hatırlatıcılar eklemenize olanak tanır; örneğin, bir resim bölümünü güncellemelerini veya daha sonra yeni örnekler eklemelerini hatırlatabilirsiniz.

Tablolar, katlanabilir bölümler ve içerik ayrımı

GitHub Flavored Markdown'daki en kullanışlı geliştirmelerden biri tablo desteğidir . Hücreleri ayırmak için dikey çubuklar ve başlığı işaretlemek için bir dizi tire kullanarak verileri satır ve sütunlara ayırabilirsiniz. Ayrıca ayırıcı satırda iki nokta üst üste kullanarak sütunları sağa, sola veya ortaya hizalamak da mümkündür.

Tablolar, programlama dilleri, kullanılan çerçeveler, planlanan görevler, özellik karşılaştırmaları veya matris yapısından fayda sağlayan diğer bilgilerin listelerini sunmak için çok kullanışlıdır. GitHub bu tabloları temiz ve okunabilir bir stille oluşturur.

Uzun bir README dosyasını düzenli tutmak için, daraltılabilir bölümler oluşturmak üzere `<details>` HTML etiketini kullanabilirsiniz. Bu bölümler, `<summary>` etiketi içinde bir özet görüntüler ve kullanıcının ihtiyaç duyduğu ek içeriği genişletmesine veya daraltmasına olanak tanır . Kullanıcıyı ilk bakışta bunaltmaktan kaçınmak için tabloları veya ikincil bilgi bloklarını `<details>` içine almak yaygın bir uygulamadır.

Bölümün varsayılan olarak genişletilmiş görünmesini istiyorsanız, `open` özelliğini eklemeniz yeterlidir. Bu teknik, sıralamaları, uzun listeleri veya ilk okuma için gerekli olmayan ancak erişilebilir olması uygun olan içerikleri gruplandırmak için çok pratiktir.

Bilgileri düzenlemek için kullanılabilecek bir diğer basit araç ise yatay çizgidir. Bir çizgi üzerine üç veya daha fazla çizgi çizilerek oluşturulur ve bölümler arasında bir ayırma çizgisi oluşturmaya yarar; örneğin, açıklayıcı bir bölümü referanslar veya ek notlar bölümünden net bir şekilde ayırmanıza olanak tanır.

Bu kurallar, ilham verici ifadeleri, hatırlatmaları veya önemli mesajları vurgulamak için belge sonu alıntılarıyla birleştirilebilir. Tipik bir örnek, profilinizin README dosyasının sonuna, ayırıcı bir çizginin ardından blok alıntı şeklinde biçimlendirilmiş motive edici bir alıntı yerleştirmek olabilir.

Gizli yorumlar ve biçimlendirme kontrolü

GitHub, <!-- yorum --> sözdizimini kullanarak Markdown içine HTML yorumları eklemenize olanak tanır . Bu yorumun içine yazdığınız hiçbir şey oluşturulan içerikte görüntülenmez, ancak kaynak kodda görünür; bu da onu dahili notlar veya yapılacaklar listeleri için ideal hale getirir.

Örneğin, bir profilin README dosyasına, "Hakkımda" bölümünü daha sonra genişletmeniz gerektiğini veya artık kullanılmayan teknolojiler tablosunu gözden geçirmeniz gerektiğini belirten bir yorum ekleyebilirsiniz; ancak bu yorum profili ziyaret eden hiç kimse tarafından doğrudan görülmez.

Bir diğer kullanışlı özellik ise normalde Markdown olarak yorumlanacak karakterlerden kaçış karakteri kullanmaktır . Yıldız işaretlerini, hashtag sembollerini veya diğer sembolleri biçimlendirmeden olduğu gibi göstermeniz gerekiyorsa, her birinin önüne bir ters eğik çizgi koymanız yeterlidir. Bu, örneğin, liste sembollerini gerçek listelere dönüştürmeden liste sembolleri içeren ifadeler yazmanıza olanak tanır.

GitHub'da bir işaretleme dosyasını görüntülerken, üst kısımda bulunan bir düğme ile işlenmiş görünüm ile kaynak kod arasında geçiş yapma (veya Brackets gibi editörlerde açma) seçeneğiniz vardır. Markdown yorumlamasını devre dışı bırakmak, belirli satırları bağlama gibi tipik kod görünümü özelliklerine erişmenizi sağlar ; bu, bir README veya herhangi bir .md dosyasının belirli bir bölümünü vurgulamak istediğinizde çok kullanışlıdır.

Son olarak, GitHub'ın yorumlarda (sorunlar, çekme istekleri vb.) ve .md dosyalarında satır sonlarını farklı şekilde ele aldığını unutmayın. Yorumlarda satır sonları doğrudan dikkate alınırken, Markdown dosyalarında satırın sonuna iki boşluk, ters eğik çizgi veya nokta eklemeniz gerekir. Aynı paragraf içinde atlamayı zorlamak.

Listeler, iç içe listeler ve yapılacaklar listeleri

Listeler, hem GitHub'da hem de Reddit'te Markdown'da en sık kullanılan öğelerden biridir. Her liste öğesinin önüne tire, yıldız işareti veya artı işareti koyarak sıralı olmayan listeler oluşturabilirsiniz . Bu işaretlerin tümü madde işaretlerine benzer şekilde görüntülenir.

Sıralı listeler oluşturmak için , her satırı bir sayı, ardından bir nokta ve bir boşlukla numaralandırın. Sayıların sırası mükemmel olmak zorunda olmasa da (GitHub genellikle yeniden hesaplar), kaynak kodunun okunabilirliğini korumak için tutarlı bir numaralandırma sağlamak iyi bir fikirdir.

İç içe listeler, altlarındaki öğeleri girintileyerek oluşturulur. Sublime Text gibi tek aralıklı yazı tipi kullanan editörlerde , iç içe liste işaretleyicilerini üst öğedeki metnin ilk karakterinin altına görsel olarak hizalamanız yeterlidir. GitHub yorum editörü gibi yazı tipinin tek aralıklı olmadığı ortamlarda, metinden önce kaç karakter olduğunu saymalı ve girinti için bu boşluk sayısını kullanmalısınız.

Boşluk sayısında tutarlılığı koruduğunuz sürece, birden fazla iç içe geçme seviyesi de oluşturabilirsiniz. Çok karmaşık listeler için bu sistem biraz pratik gerektirir, ancak bir kez alıştıktan sonra uygulaması çok hızlıdır.

GitHub ayrıca, sorunlar, çekme istekleri ve dokümantasyon için çok kullanışlı olan görev listeleri de sunar . Bunlar, listenin başına bir tire, bir boşluk ve içinde boşluk veya "x" bulunan bir çift köşeli parantez eklenerek oluşturulur: biri bekleyen görevler için, diğeri tamamlanmış görevler için. Bu listeler, arayüzden seçilebilen veya seçimi kaldırılabilen onay kutuları ile görüntülenir.

Yapılacaklar listesi öğesinin metni parantezlerle başlıyorsa, ayrıştırıcıda karışıklığı önlemek için ters eğik çizgiyle (backslash) kaçırılmalıdır. Bu küçük bir ayrıntı olsa da, "(İsteğe bağlı)" veya benzeri bir şeyle başlayan açıklamalar yazarken önemlidir.

GitHub'daki bahsetmeler, referanslar ve emojiler

GitHub'da Markdown ile yazmanın avantajlarından biri , platformdaki kullanıcıları ve ekipleri doğrudan etiketleyebilme özelliğidir . Sadece @ işaretini ve ardından kullanıcı adını veya ekip adını yazmanız yeterlidir; GitHub bu hesaba bir bildirim göndererek dikkatlerini konuşmaya çeker.

@ sembolünü yazdığınızda, GitHub, depo veya konuyla ilişkili kullanıcıların ve ekiplerin bir listesini görüntüler ve yazarken bu listeyi filtreleyebilirsiniz. Önerileri kabul etmek için ok tuşlarını kullanın ve Enter veya Tab tuşuna basın. Ekipler için @kuruluş/ekip-adı formatını kullanın ve tüm ekip üyeleri konuya abone olacaktır.

GitHub, bahsetme özelliğine ek olarak, # işaretini ve ardından bir sayıyı veya başlığın bir bölümünü yazarak sorunlara ve çekme isteklerine kolayca referans vermeyi sağlar . Önerilen sonuçların bir listesi görünür ve bunları bahsetmelerde olduğu gibi tamamlayabilirsiniz. Bu, ilgili konuşmalar arasında gezinmeyi büyük ölçüde hızlandırır.

Deponuzda özel otomatik bağlantılı referanslar yapılandırılmışsa, belirli harici gösterimler (örneğin JIRA veya Zendesk bilet kimlikleri) otomatik olarak kısa bağlantılara dönüştürülebilir. Bu ayar yönetici ayrıcalıkları gerektirir, ancak etkinleştirildikten sonra, minimum çabayla sistemler arası veri paylaşımına olanak tanır.

Son olarak, GitHub kod aracılığıyla emoji kullanımını destekliyor: bir iki nokta üst üste, ardından emoji adını yazın ve son olarak bir iki nokta üst üste daha yazın. Yazmaya başladığınızda, Tab veya Enter tuşlarıyla onaylayabileceğiniz bir öneri listesi görünür. Yorumlarınıza emoji eklemek, resmi belgelerde aşırı kullanmadığınız sürece, yorumlarınıza daha insani bir dokunuş katmanıza yardımcı olur.

Dipnotlar ve ileri düzey içerik

GitHub ayrıca köşeli parantez tabanlı bir sözdizimi ve şapka karakteri içeren bir tanımlayıcı kullanarak dipnotları da destekler . Referansı istediğiniz noktaya `<dipnot>` gibi bir şey eklersiniz ve belgenin sonunda, aynı etiketi, ardından iki nokta üst üste ve içeriği kullanarak o dipnotun metnini tanımlarsınız.

Dipnotlar birden fazla satıra yayılabilir ve bir dipnot içinde satır sonu oluşturmak için, Markdown'ın ana gövdesinde olduğu gibi satırın sonunda çift boşluk kullanılır. Oluşturma sırasında GitHub, metnin üzerinde bir üst simge ve sonunda dipnotların bir listesini görüntüler; referanslar ve dipnotlar arasında gezinmek için geri bağlantılar da bulunur.

GitHub'ın sunduğu bir diğer gelişmiş özellik ise daha önce bahsedilen uyarılar (NOT, İPUCU, ÖNEMLİ, UYARI ve DİKKAT) özelliğidir. Okuyucuyu bunaltmamak için bunları yalnızca gerçekten gerekli olduğunda kullanmanız ve çok fazla uyarıyı bir arada kullanmaktan kaçınmanız önerilir. Bunlar diğer karmaşık öğelerin içine yerleştirilemez, bu nedenle yerleşimleri için dikkatli planlama şarttır.

Son olarak, GitHub'dan oluşturulan Markdown bölümlerinin HTML yorumlarıyla sarmalanarak geçici olarak gizlenmesini veya ters eğik çizgi içeren belirli karakterlerin işlenmesinin göz ardı edilmesini isteyebilirsiniz. Bu, özellikle Markdown sözdizimini belgelediğinizde ve örnekleri yorumlama yapmadan olduğu gibi göstermeniz gerektiğinde kullanışlıdır.

Reddit'te Markdown: Snoomark ve düzenleme modu

Reddit, alt forumlar (subredditler) halinde düzenlenmiş, neredeyse her konunun hoş karşılandığı bir tartışma platformudur. Biçimlendirme açısından iki editör sunar: biri daha görsel olan zengin metin için, diğeri ise Markdown tabanlı düz metin için. Hızlı çalışmak ve sonuç üzerinde ince ayar yapmak istiyorsanız, Markdown seçeneğini kullanmanız gerekir.

Reddit varsayılan olarak genellikle zengin metin düzenleyicisini etkinleştirir, bu nedenle işaretleme moduna geçmek için bir gönderinin veya yorumun metin kutusundaki Markdown modu seçeneğine tıklamanız gerekir . Oradan, doğrudan Snoomark sözdizimini kullanabilirsiniz.

Markdown düzenleyicisinin her zaman yüklenmesini tercih ediyorsanız, kullanıcı ayarlarınıza gidin, Besleme Ayarları bölümüne girin ve "Varsayılan olarak Markdown'ı seç" seçeneğini etkinleştirin . Bu sayede, bir gönderi veya yorum yazmaya başladığınızda Markdown düzenleyicisi otomatik olarak açılacak ve manuel olarak değiştirmenize gerek kalmayacak.

Reddit, başlıklar, kalın ve italik yazı tipleri, listeler, alıntılar, kod blokları, bağlantılar ve spoiler gibi kendi ek özellikleri de dahil olmak üzere Markdown'ın en temel ve gelişmiş özelliklerinin çoğunu destekler. Bununla birlikte, özellikle bağlama ve editör türüne büyük ölçüde bağlı olan görüntü işleme konusunda GitHub'a kıyasla önemli eksiklikleri vardır.

Reddit ve spoiler'lar tarafından desteklenen sözdizimi.

Reddit tarafından kullanılan Snoomark varyantı, GitHub ile birçok ortak unsur içeriyor; bu nedenle, depolar için Markdown konusunda zaten yetkinseniz, bu bilgiyi Reddit ortamına aktarmak oldukça kolaydır. Uzun gönderileri yapılandırmak için başlıklar, numaralı veya madde işaretli listeler, diğer kullanıcılara yanıt vermek için alıntılar ve komutları veya teknik kod parçacıklarını görüntülemek istediğinizde kod blokları kullanabilirsiniz.

Dikkat çekici farklılıklardan biri de Reddit'in görselleri nasıl ele aldığıdır . Görseller birçok durumda doğrudan Markdown sözdizimiyle değil, grafik arayüz üzerinden yüklense de, metin içeriğini işleyen motor hala Snoomark'tır; bu nedenle görsellerin etrafındaki biçimlendirme aslında Markdown'a dayanmaktadır.

Öte yandan Reddit, standart özelliklerde yer almayan spoiler gibi ek özellikler sunuyor . Bu özellik, kullanıcının bir tıklamayla ortaya çıkarabileceği bir katmanın arkasına gizlenmiş metinler oluşturmasına olanak tanıyor. Teknik olarak, Reddit bir spoiler'ı işlerken onu HTML, CSS sınıfları ve platforma özgü JavaScript'in bir kombinasyonuna dönüştürüyor.

Ortaya çıkan HTML spoiler gösterimi, içeriğin ne zaman gösterileceğini veya gizleneceğini kontrol eden işleyiciler içerir ve teorik olarak benzer bir şey düz HTML ile de yazılabilirken, Reddit'te bu, içsel uygulamasına bağlıdır. Kullanıcı olarak sizin için önemli olan, yazarken yalnızca editör tarafından sağlanan özel spoiler sözdizimini kullanmanız gerektiğidir ve Snoomark bunu uygun yapıya çevirmeyi üstlenir .

Özetle, Snoomark, GitHub Flavored Markdown'dan birçok davranışı miras alıyor, ancak proje dokümantasyonundan ziyade bir tartışma topluluğunun ihtiyaçlarına yönelik olarak tasarlanmış durumda. Yine de temel aynı kalıyor: basit sembollerle oluşturulmuş düz metin, yapılandırılmış ve okunabilir içeriğe dönüştürülüyor.

GitHub ve Reddit'te Markdown sözdizimine hakim olmak, teknik dokümantasyon yazmayı, iyi açıklanmış sorunlar açmayı, çekme isteklerine net yorumlar bırakmayı ve Reddit tartışmalarına katılmayı çok daha verimli hale getirir. Başlıklar, vurgu, listeler, alıntılar, kod blokları, bağlantılar, resimler ve tablolar, daraltılabilir ayrıntılar, uyarılar, dipnotlar ve spoiler gibi özel püf noktaları gibi birkaç temel kural sayesinde, tek bir fare düğmesine tıklamadan sıradan mesajlar yazmaktan temiz, taranabilir ve profesyonel içerik oluşturmaya geçebilirsiniz.