GitHub ve Dokümantasyon İçin Markdown Katlanır Bölümler Oluşturma Rehberi
Markdown Katlanır Bölümler Nedir?
Markdown, düz metin belgelerini, README dosyalarını ve geliştirici dokümantasyonunu biçimlendirmedeki basitliğiyle yaygın olarak tanınır. Ancak standart Markdown sözdizimi, etkileşimli akordeon bileşenleri veya katlanır içerik açma/kapatma düğmeleri için yerel desteğe sahip değildir. Bunu ağır JavaScript bağımlılıklarına ihtiyaç duymadan çözmek için modern Markdown ayrıştırıcıları, inline HTML5 etiketlerini—özellikle <details> ve <summary> etiketlerini destekler.
Ücretsiz çevrimiçi Markdown Katlanır Bölüm Oluşturucumuzu kullanarak, uzun teknik özellikleri, ayrıntılı günlük çıktılarını, kapsamlı SSS bölümlerini ve ikincil kod örneklerini temiz, genişletilebilir açılır kapsayıcılara anında dönüştürebilirsiniz. Bu, temel arka plan içeriğinden ödün vermeden belgenin taranabilirliğini ve kullanıcı deneyimini iyileştirir.
HTML5 Details ve Summary Sözdizimi İncelemesi
Herhangi bir Markdown akordeon düğmesinin temeli iki standart HTML etiketine dayanır:
<details>Kapsayıcı Etiketi: Hem görünür başlığı hem de gizli genişletilebilir gövde içeriğini tutan etkileşimli kapsayıcı görevi görür. İsteğe bağlıopenözniteliğini eklemek (<details open>), web sayfası veya README yüklendiğinde kapsayıcının varsayılan olarak genişlemesine neden olur.<summary>Başlık Etiketi: Kullanıcıların içeriğin görünürlüğünü değiştirmek için tıkladığı görünür başlığı veya etiketi tanımlar. Özel stil, metin biçimlendirmesi ve inline Markdown genellikle bu öğenin içine veya yanına dahil edilebilir.
Standart Sözdizimi Yapısı Örneği:
<details>
<summary>Ayrıntılı kurulum talimatlarını görüntülemek için buraya tıklayın</summary>
### Önkoşullar
- Node.js v18+
- npm veya yarn
Bağımlılıkları yüklemek için aşağıdaki komutu çalıştırın:
```bash
npm install utiliome-tools
</details>
```[!IMPORTANT] Markdown Ayrıştırıcıları İçin İpucu: Çoğu Markdown işlemcisi (GitHub Flavored Markdown gibi), gövde içeriğiniz başlamadan önce kapanış
</summary>etiketinden sonra boş bir satır gerektirir. Bu boş satır olmadan, başlıklar (###), listeler (-) veya kod blokları (```) gibi iç içe geçmiş Markdown sözdizimleri ayrıştırılmış HTML öğeleri yerine ham biçimlendirilmemiş metin olarak işlenir.
Genişletilebilir Katlanır İçerik İçin Yaygın Kullanım Alanları
1. GitHub README Dosyalarını Temizleme
Depolar genellikle ayrıntılı kurulum talimatları, çevre değişkenleri listeleri ve API referans parametreleri gerektirir. Tüm bu bilgileri doğrudan tek bir sayfaya yerleştirmek sonsuz kaydırmaya neden olur. Komut günlüklerini ve yapılandırmaları katlanır <details> blokları içine sarmak README'nizi temiz tutar.
2. Temiz SSS Sayfaları Oluşturma
Sıkça Sorulan Sorular doğal olarak bir akordeon düzenine uyar. Katlanır HTML etiketlerini kullanmak, kullanıcıların üst düzey soruları hızlıca taramasına ve yalnızca kendi sorgularıyla ilgili yanıtları genişletmesine olanak tanır.
3. Test Sonuçlarını ve Hata İzlerini (Stack Traces) Gizleme
GitHub veya GitLab'da çekme isteği açıklamaları veya sorun raporları yayınlarken büyük test çıktıları yapıştırmak tartışmaları karmaşıklaştırabilir. Günlük çıktılarını katlanmış bir bölüme sarmak, inceleyenler için tüm teşhis ayrıntılarını korur.
4. Etkileşimli Dokümantasyon ve Bilgi Tabanları Düzenleme
Docusaurus, MkDocs, Hugo, Jekyll ve GitBook gibi dokümantasyon platformları HTML details öğelerini sorunsuz bir şekilde işler. Teknik okuyucular için zihinsel yükü azaltmak amacıyla çok adımlı öğreticileri ve kod parçacıklarını katlanır panellerde kolayca kategorize edebilirsiniz.
Platform Uyumluluk Rehberi
| Platform / Ayrıştırıcı | Katlanır <details> Desteği |
Details İçinde Markdown Desteği | Notlar |
|---|---|---|---|
| GitHub (GFM) | Tam Yerel Destek | Tam Destekleniyor (<summary> sonrasında boş satır gerektirir) |
README.md, PR açıklamaları ve sorun yorumları için idealdir. |
| GitLab | Tam Yerel Destek | Tam Destekleniyor | Standart HTML details/summary ayrıştırması. |
| Notion | Yerel Açılır Liste Bloğu | İçe Aktarma İle Destekleniyor | Temiz bir şekilde içe aktarılır veya açılır blok olarak yapıştırılır. |
| Obsidian | Yerel ve HTML Desteği | Tam Destekleniyor | Hem eklenti anahtarlarını hem de standart HTML etiketlerini destekler. |
| Azure DevOps | Kısmi Destek | Temel Destek | Wiki sayfalarında basit details etiketlerini destekler. |
| Jekyll / Hugo | Tam Yerel Destek | Markdown uzantı yapılandırması gerektirir | Statik site derlemelerinde geçerli HTML çıktısı sağlar. |
Markdown Akordeonları Tasarlamak İçin En İyi Uygulamalar
- Net, Eyleme Geçirilebilir Özet Başlıkları Kullanın: "Daha Fazla Bilgi" gibi belirsiz başlıklardan kaçının. Bunun yerine "Tüm Test Sonuçlarını Görüntüle" gibi açık başlıklar kullanın.
- Görsel İpuçları veya Emojiler Ekleyin: Özet etiketinin içine ok göstergeleri veya emojiler (örn.
▶️,🔍,📋) eklemek, bölümün etkileşimli olduğuna dair anında görsel geri bildirim sağlar. - İç İçe Yapıyı Doğru Şekilde Girintileyin: Sıkı Markdown derleyicilerinde sözdizimi bozulmasını önlemek için iç içe geçmiş HTML veya Markdown blokları için temiz girinti sağlayın.