Markdown TOC Generator
Generate table of contents links from markdown headings
Input Markdown
Generated TOC
Markdown TOC Oluşturucu Nedir?
Gezinmesi güçleşen bir belge veya uzun README mi oluşturuyorsunuz? İçerik tablosu (TOC), okuyucuların ilgilendikleri bölümlere atlamasını kolaylaştırır. Bu araç Markdown dosyanızı tarar, tüm başlıkları (H1'den H6'ya) bulur, uygun bağlantı bağlantıları oluşturur ve belgenin üstüne yapıştıracağınız yapılandırılmış bir TOC oluşturur.
Oluşturucu, GitHub uyumlu bağlantı formatını kullanır, böylece TOC'unuz GitHub, GitLab ve Markdown render eden diğer platformlarda mükemmel çalışır. Başlık düzeylerini akıllıca yönetir — TOC derinliğini kontrol edebilirsiniz (yalnızca H2-H3 göstermek veya H6'ya kadar tüm düzeyleri dahil etmek), ve otomatik olarak doğru girinti ve iç içe geçme oluşturur.
TOC'unuz her zaman başlıklarınızla senkronizedir — artık bozuk bağlantı bağlantıları veya eski bölüm referansları yok. Başlıklardaki özel karakterler doğru şekilde yönetilir ve çıktı hemen yapıştırmaya hazırdır. Her şey tarayıcınızda anında gerçekleşir.
Markdown TOC Oluşturucu Nasıl Kullanılır
Markdown başlıklarından içerik tablosu oluşturmak için bu adımları izleyin.
Yapıştırın, Yükleyin veya Örnek Yükleyin
Sol Girdi Markdown paneline Markdown yapıştırın ya da bir .md dosyası yüklemek için Yükle'ye tıklayın. Örnek belge görmek için Örnek'e tıklayın. Araç başlıkları tarar (# ile ###### arası).
Min/Max Düzeyleri Yapılandırın
TOC'ta hangi başlık düzeylerinin görüneceğini kontrol etmek için Min H ve Max H açılır menülerini kullanın. Çıktı anında güncellenir. GitHub uyumlu bağlantı bağlantıları.
Kopyalayın veya İndirin
Çıktıyı kullanmak için Kopyala veya İndir'e tıklayın. Belgenizin üstüne yapıştırın. Yeniden başlamak için Temizle'yi kullanın. Tüm işlem tarayıcınızda gerçekleşir.
Bunu Gerçekten Ne Zaman Kullanırsınız
GitHub'daki README Dosyaları
Projeniz için kapsamlı bir README mi oluşturuyorsunuz? TOC, kullanıcıların setup, yapılandırma, API belgeleri ve katkı bölümlerini hızla bulmasına yardımcı olur. GitHub, TOC'unuzu çalışan bağlantı bağlantılarıyla otomatik olarak render eder.
Belgeleme Siteleri
20+ sayfalık büyük belgeleme projeleri yapıya ihtiyaç duyar. Her sayfa için TOC'lar oluşturun ve tüm site için bir ana TOC oluşturun. Okuyucular net yapıyla belgelemenizde güvenle gezinir.
Wiki Sayfaları
Uzun makalelerle kurumsal wiki'ler veya bilgi tabanları mı oluşturuyorsunuz? Her sayfanın üstündeki TOC kullanılabilirliği artırır. GitHub Wiki, GitLab Wiki ve diğer Markdown tabanlı wiki'lerde çalışır.
Uzun İçerik
Blog yazıları, öğreticiler, kılavuzlar veya uzun Markdown belgeleri TOC'tan yararlanır. Hızlı tarama yapan okuyucular doğrudan ilgili bölümlere atlayabilir. Birden fazla adım ve bölümü olan teknik öğreticiler için özellikle kullanışlıdır.
Sıkça Sorulan Sorular
Bağlantı bağlantılarını manuel olarak oluşturmam gerekiyor mu?
Hayır. Araç bunları otomatik olarak oluşturur. GitHub, GitLab ve çoğu CommonMark uyumlu platform, başlıklardan otomatik olarak bağlantılar oluşturur, bu nedenle oluşturulan TOC bağlantıları ek çalışma olmadan hemen çalışır.
Bağlantı formatı tüm platformlarda çalışıyor mu?
Oluşturucu, en yaygın desteklenen format olan GitHub uyumlu bağlantı formatını kullanır. GitHub, GitLab ve çoğu diğer Markdown platformu bu formatı yerel olarak destekler.
Başlıklardaki özel karakterler nasıl işlenir?
Oluşturucu, özel karakterleri otomatik olarak bağlantı güvenli formatlara dönüştürür. Boşluklar kısa çizgilere dönüşür, büyük harfler küçük harflere dönüşür ve özel noktalama dönüştürülür veya kaldırılır. Sonuçtaki bağlantılar her zaman geçerlidir.
TOC derinliğini ayarlayabilir miyim?
Kesinlikle. "Min H" açılır menüsü minimum başlık düzeyini (H1, H2, vb.) kontrol eder ve "Max H" maksimumu kontrol eder. Yalnızca H2-H3 mü istiyorsunuz? Min'i H2 ve Max'ı H3 olarak ayarlayın. Tam TOC mu gerekiyor? H1'den H6'ya tüm düzeyleri dahil edin.
Başlıklarım sayı veya sembol içeriyorsa ne olur?
Doğru şekilde işlenirler. "1. Adım: Başlarken" gibi bir başlık, #1-adım-başlarken gibi bir bağlantıya dönüştürülür. Özel karakterler standart Markdown bağlantı kurallarına göre işlenir.
Markdown içeriğim saklanıyor mu?
Hayır. Tüm TOC oluşturma JavaScript kullanılarak tarayıcınızda gerçekleşir. Markdown'ınız hiçbir zaman bilgisayarınızdan çıkmaz. Tam gizlilik ve güvenlik.