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 düzenli olarak yazı yazıyorsanız veya Reddit'te çok zaman geçiriyorsanız, bu konuda uzmanlaşmak... Markdown Bu, size saatlerce zaman kazandıran ve hayatınızı kolaylaştıran şeylerden biri. Çok hafif bir işaretleme dili olup, 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ğlar.

GitHub'da her yerde bulabilirsiniz: dosyalarda. README.md Depolardan, sorunlardan, çekme isteklerinden, tartışmalardan ve hatta kendi profilinizden bile. Reddit ise, GitHub'ın sözdiziminin büyük bir kısmını miras alan, ancak bazı benzersiz özelliklere ve belirli sınırlamalara sahip Snoomark (Reddit tarzı Markdown) adı verilen bir varyant kullanıyor. Gelin, adım adım ve birçok örnekle inceleyelim. GitHub ve Reddit'te Markdown'ı hızlıca nasıl kullanabilirsiniz? ve hiçbir önemli noktayı atlamadan.

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

Markdown bir hafif işaretleme dili Düz metni okumayı ve yazmayı kolaylaştırmak, aynı zamanda HTML'ye zahmetsizce dönüştürmeye olanak sağlamak üzere tasarlanmıştır. 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 özel karakterler 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 otomatik olarak oluşturuluyor. .md dosyalarında ve platformun yorum alanlarında.

Reddit, GFM'nin bir türevi olan Snoomark adlı kendi işlemcisini kullanıyor. Temel davranışların ç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 kendine özgü özellikleri var. önemli özelliklerÖrneğin, görsel desteği bağlama bağlı olarak daha sınırlıdır ve spoiler gibi kendi unsurlarını da ekler.

Tüm bunların güzelliği, tek bir sözdizimiyle hem GitHub'da hem de Reddit'te iyi görünecek metinler yazabilmeniz ve her platformun farklı çalıştığı noktalarda yalnızca birkaç ayrıntıyı uyarlamanız gerekebilmesidir. Temel kuralları öğrenin Bu sayede her iki alanda da hiçbir şeyi sıfırdan öğrenmek zorunda kalmadan özgürce hareket edebilirsiniz.

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

Kullanacağınız ilk şeylerden biri şunlardır: başlıklarıHem GitHub'da hem de Reddit'te metni bölümlere ve alt bölümlere ayırmak için kullanılırlar.

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, otomatik olarak bir başlık dosyası oluşturur. içindekiler tablosu Dosyanın üst kısmındaki "Anahat" simgesinden erişilebilir. Her başlık, sizi doğrudan ilgili bölüme götüren bir bağlantı olarak görünür; bu da uzun belgeler için harika bir özelliktir.

Ek olarak, 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, sayısal bir sonek ekle (-1, -2, vb.) onu benzersiz kılmak için.

Bu, bir bölüm yerleştirmek gibi şeyler yapmanıza olanak tanır. ## Örnek Bölüm ve daha sonra belgenin başka bir noktasından şu şekilde bir bağlantı ile ona bağlanabilirsiniz: (#örnek-bölüm)Hatta başlığında özel karakterler bulunan bölümlere bile bağlantı verebilirsiniz, çü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, çeşitli yöntemler kullanarak metni vurgulamanıza olanak tanır. vurguKalın, italik, üstü çizili, alt simge, üst simge veya alt çizgi. GitHub'da tipik stil tablosu şöyle bir şey olurdu, ancak burada farklı kelimelerle özetledik:

Metin koymak için kalın tipKalın metin çift yıldız veya çift alt çizgiyle çevrelenir; italik için tek yıldız veya alt çizgi kullanılır; bir şeyin üzerini çizmek için metnin her iki tarafına çift tilde (iki tilde) yerleştirilir. İç içe kalın ve italik de birleştirilebilir, bir metnin tamamına her ikisini de uygulamak için üç yıldız kullanılabilir veya <br> gibi HTML etiketleri kullanılabilir. _{y ^{alt simgeler ve üst simgeler için ve alt çizgiler için.}}

GitHub ayrıca oluşturmanıza da olanak tanır. blockquote tarzı alıntılar Alıntılanan metin, satırın başına büyüktür (>) sembolü yerleştirilerek, solunda dikey bir çizgiyle ve gri renkte görüntülenir, böylece daha belirgin hale gelir. Aynı alıntı bloğuna birden fazla satır eklenebilir ve hatta başına daha fazla > sembolü eklenerek alıntılar iç içe yerleştirilebilir.

GitHub'da bulunan ve yalnızca orada geçerli olan gelişmiş bir alıntı biçimi şunlardır: uyarılar veya ikazlarBunlar aynı alıntı bloğu sözdizimine dayanır, ancak ilk satırda uyarı türünü belirtmek için özel bir işaretleyici bulunur. Örneğin, yararlı bilgiler için `<alert>`, pratik tavsiyeler için `<helpful tips>`, önemli veriler için `<key data>`, acil uyarılar için `<urgent notices>` ve risk veya olumsuz sonuçlara ilişkin uyarılar için `<alert>` belirtebilirsiniz. GitHub, her türü farklı bir renk ve simgeyle göstererek dokümantasyondaki kritik bilgileri vurgulamaya yardımcı olur.

Reddit, GitHub'ın zengin uyarı sistemine sahip olmasa da, aynı sembol olan > ile basit alıntıları da destekliyor. Yine de, oldukça kullanışlı bir yöntem olmaya devam ediyor. Birinin mesajının bir kısmını alıntılayarak ona cevap vermek Tamamen tekrar etmeden.

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 metni vurgulamak için idealdir. git durumu Bir cümle içinde, bunun bir emir olduğunu açıkça belirterek.

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 üç ters tırnak işaretiyle bitirirsiniz. GitHub'da, ilk ters tırnak işaretinden hemen sonra dili de belirtirseniz, bu uygulanır... sözdizimi vurgulama O dile özgü renkler ve formatla.

GitHub ayrıca vurgulama için özel bir özellik de sunmaktadır. renk değerleri Ters tırnak işaretleri içinde. Eğer 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ın vurgulanması hangisinin hangisi olduğunu hızlıca görmenizi sağlar.

Kod ve tablo görselleştirmesiyle ilgili olarak, GitHub, teknik metinlerle çalışmayı daha rahat hale getirmek için tüm yorum alanlarında sabit, tek aralıklı bir yazı tipini etkinleştirmenize olanak tanır. Tarayıcınızda veya editörlerde çok sayıda kod parçacığı düzenliyorsanız, bu özellik size yardımcı olabilir. Visual Studio KoduBu seçeneği etkinleştirmek hizalamayı ve okumayı kolaylaştırır. çok daha tutarlı.

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. Örneğin, şunlara izin veriyor: Başlıklara doğrudan bağlantı Daha önce ele alınan parça oluşturma kurallarını kullanır. Ayrıca, teknik dokümantasyonda çok önemli olan, depo içindeki göreceli bağlantıları da destekler.

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.

Her zaman şunu kullanmanız önerilir: göreli yollar Aynı depodaki dosyalar arasında gezinmek için, mutlak bağlantılar klonlarda veya çatallarda çalışmayı durdurabileceğinden, GitHub, ./ veya ../ gibi standart operatörlerin ve proje kök dizinine 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 resimler 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 resmin URL'si veya yolu parantez içine yerleştirilir. Bu alternatif metin, erişilebilirlikÇünkü ekran okuyucular bunu okuyacak ve görüntü yüklenmezse de bu görüntü ekranda gösterilecektir.

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, örneğin şu gibi son ekler kullanarak birden fazla göreceli yol kalıbına izin verir: ?raw=true Gerektiğinde dosyanın doğrudan indirilmesini zorlamak.

GitHub, standart Markdown sözdizimine ek olarak HTML öğesinin kullanımını da destekler. Bu ürün özellikle şarj için kullanışlıdır. duyarlı görüntüler Bunlar, kullanıcının tema tercihlerine (açık veya koyu) göre değişir. `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, şu özelliği desteklemesidir: çizmekHücreleri ayırmak için dikey çubuklar ve başlığı işaretlemek için kesikli çizgi kullanarak verileri satır ve sütunlar halinde düzenleyebilirsiniz. Ayrıca ayırıcı satırda iki nokta üst üste kullanarak sütunları sağa, sola veya ortaya hizalayabilirsiniz.

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 HTML etiketini kullanabilirsiniz. Katlanabilir bölümler oluşturmak için. Bu bölümler etiket içinde bir özet görüntüler. ve kullanıcının genişletmesine veya daraltmasına izin verir. ek içerik Gerektiğinde. Tabloları veya ikincil bilgi bloklarını içine almak yaygın bir uygulamadır. Gözü yormamak için.

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, tanıtmanıza olanak tanır. HTML yorumları Markdown içinde sözdizimini kullanarak Bu yorumun içine yazdığınız hiçbir şey oluşturulan içerikte görünmeyecek, ancak kaynak kodda görünür olacak; bu nedenle dahili notlar veya yapılacaklar listeleri için idealdir.

Ö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 yararlı işlevi ise kaçış karakterleri Bu, normalde Markdown olarak yorumlanacak bir metin türüdü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 seçeneğiniz vardır (veya dosyayı editörlerde açabilirsiniz). ParantezMarkdown yorumlamasını devre dışı bırakmak, aşağıdaki gibi tipik kod görüntüleme özelliklerine erişmenizi sağlar: bağlantı belirli satırlarBu, README veya herhangi bir .md dosyasının tam olarak belirli bir bölümünü işaret etmek 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 çok kullanılan öğelerden biridir. Listeler oluşturabilirsiniz. sıralanmamış Her liste öğesinin önüne tire, yıldız işareti veya artı işareti koyarak. Bu işaretlerin tümü madde işaretleriyle aynı şekilde görüntülenir.

Listeler oluşturmak için siparişHer satır, bir rakam, ardından bir nokta ve bir boşlukla numaralandırılır. Rakamların sırası mükemmel olmak zorunda olmasa da (GitHub genellikle yeniden hesaplar), kaynak kodunun okunabilirliğini sağlamak için tutarlı bir numaralandırma kullanmak iyi bir fikirdir.

İç içe listeler, altlarındaki öğelere girinti eklenerek kolayca oluşturulur. Tek aralıklı yazı tipi kullanan editörlerde olduğu gibi Sublime Textİç içe geçmiş liste işaretleyicilerini, üst öğedeki metnin ilk karakterinin altına görsel olarak hizalayın. GitHub yorum düzenleyicisi gibi yazı tipinin tek aralıklı olmadığı ortamlarda, metinden önceki karakter sayısını sayın ve girinti için bu boşluk sayısını kullanın.

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 şunları da sunuyor: yapılacaklar listesiBunlar, sorunlar, çekme istekleri ve dokümantasyon için çok kullanışlıdır. Bir tire, bir boşluk ve ardından boşluk veya "x" işaretiyle belirtilen bir çift köşeli parantez kullanılarak oluşturulurlar: bekleyen görevler için ve tamamlanmış görevler için. Bu listeler, arayüzden işaretlenebilen veya işareti 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 de, bu dili kullanabilmektir. söz Platformdaki kullanıcılara ve ekiplere doğrudan mesaj gönderin. Sadece @ işaretini ve ardından kullanıcı adını veya ekip adını yazın; GitHub, ilgili hesaba bir bildirim göndererek dikkatlerini konuşmaya çekecektir.

@ 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.

Bahsetmelere ek olarak, GitHub şunları kolaylaştırır: referans sorunları ve çekme istekleri Sadece # işaretini ve ardından bir sayı veya başlığın bir bölümünü yazın. Önerilen sonuçların bir listesi görünecektir; 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 destekliyor Dipnotlar Köşeli parantez tabanlı bir sözdizimi ve araya karakter yerleştirilmiş bir tanımlayıcı kullanarak. Referansı istediğiniz noktaya <referans> gibi bir şey ekliyorsunuz ve belgenin sonunda aynı etiketi kullanarak, ardından iki nokta üst üste ve içeriği ekleyerek o notun metnini tanımlıyorsunuz.

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... uyarılar Bunlar daha önce ele alındı ​​(NOT, İPUCU, ÖNEMLİ, UYARI ve DİKKAT). Okuyucuyu bunaltmamak için bunları yalnızca gerçekten gerekli olduğunda kullanmanız ve çok fazla öğeyi bir arada kullanmaktan kaçınmanız önerilir. Bunlar diğer karmaşık öğelerin içine yerleştirilemez, bu nedenle yerleşimlerinin dikkatli bir şekilde planlanması ş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 dokümantasyon yaparken kullanışlıdır. Markdown'ın kendine özgü sözdizimi Ve örnekleri yorum yapmadan, oldukları gibi göstermeniz gerekiyor.

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 biçimlendirme moduna geçmek için ilgili seçeneğe tıklamanız gerekir. Markdown modu Bir gönderinin veya yorumun metin kutusu içinde. Oradan, doğrudan Snoomark sözdizimini kullanabilirsiniz.

Markdown düzenleyicisinin her zaman yüklenmesini tercih ediyorsanız, kullanıcı ayarlarına gidin, Besleme Ayarları bölümüne girin ve seçeneği etkinleştirin. Varsayılan olarak Markdown kullanılır.Bu sayede, her yazı veya yorum yazmaya başladığınızda, Markdown düzenleyici sizin manuel olarak değiştirmenize gerek kalmadan otomatik olarak açılacaktır.

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 GitHub'a kıyasla önemli eksiklikleri vardır. görüntü yönetimiBu durum, bağlama ve kullanılan editör türüne oldukça bağlıdı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 bu konuyu ele alma biçimidir. görüntülerÇoğu durumda görseller doğrudan Markdown sözdizimiyle değil, grafik arayüz üzerinden yüklense de, metin içeriğini işleyen motor yine de Snoomark'tır; bu nedenle bu görselleri çevreleyen biçimlendirme Markdown'a dayanmaktadır.

Reddit ise bunun tam tersine şunları ekliyor: ek öğeler Bunlar, spoiler gibi standart özelliklerin bir parçası olmayan unsurlardır. Bunlar, kullanıcının bir tıklamayla ortaya çıkarabileceği bir katmanın arkasına metni gizlemenizi sağlar. Teknik olarak, Reddit bir spoiler'ı işlediğinde, onu HTML, CSS sınıfları ve platforma özgü JavaScript'in bir kombinasyonuna dönüştürür.

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, editör tarafından sağlanan özel spoiler sözdizimini kullanmanız gerektiği anlamına gelir. Snoomark çeviriden sorumlu. uygun yapıya.

Ö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üman 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, vurgular, 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 ile düz metin yazmaktan, içerik oluşturmaya geçebilirsiniz. Temiz, taranabilir ve profesyonel içerik Tek bir fare düğmesine dokunmadan.