Herhangi bir yazı yazarken yazının kalitesi ve akışın takip edilebilirliği açısından içeriğin İndex’in yazılması yani Table of content önemli etmenlerden bir tanesi. Bende yazdığım yazılarımda mümkün olduğu kadar buna dikkat etmeye çalışıyorum. Org-mode ile yazarken bunun yapılması çok basit org-export-as-html  kullanıldığında size otomatik olarak başlıklarınızı hiyerarşik yapıya göre ToC yapısını oluşturuyor.

Fakat Markdown ile Github README.md dosyası yazıyorsanız iş biraz otomatikleşmeden ziyade manuele giriyor. Eğer dökümanınızı biraz uzunca yazmış iseniz, README.md dosyasının her birine teker teker el ile editlemektense bu işi otomatikleştirilmiş şekilde yapan bir sh script bulunuyor. Bu script sizin h2 h3 olarak belirttiğiniz başlıklara göre table of content otomatik olarak yapısı oluşturuyor.

Bunu yapmak için Github üzerinde yapılımış bir repo var onu kullanacağız.

Kurulumu yaptıktan sonra sh dosyasının çalışmasını pipe yada stdin metodu ile kullanabiliriz. Ben okunurluğu biraz daha güzel olduğu için stdin yöntemini kullanmayı tercih ediyorum.

Syntax olarak kullanımı şu şekilde

dosyayı indirdiğimiz noktada konsola

dediğimizde bize konsolda bu işi yapan output üretecektir, çıktılarıda dosyanın başına yapıştırarak kullanabiliriz.

Not yapıştırırken 1 satır boşluk bırakmayı unutmayın

Daha fazla bilgi için:

https://github.com/ekalinin/github-markdown-toc#remote-files

Umarım işinize yarar

Ruby ile çalışan 1 tane daha:

http://jennifermack.net/2015/04/01/a-table-of-contents-generator-for-ulysses-and-markdownxl/