Dokümantasyon
Bu kitabı sizlere neyle hazırlıyorum dersiniz? Tabii ki de Markdown!
Markdown ile yapabilecekleriniz elbette ki sizin hayal gücünüze bağlı fakat benim için asıl işlevi, kaliteli dokümantasyonlar hazırlamak. Blog yazıların da birer doküman olduğunu düşünürseniz bu iş, Kitaplara, yazılımlar için oluşturulan yardım belgelerine kadar eğriliyor elbette.
Bu kitabı nasıl hazırladığım elbette ki ekler kısmında yer alacak ama benim asıl değineceğim konu, Markdown ile ne tarz belgeler hazırlanabileceği konusu.
Tek Dosya HTML
Hani uygulamalarımızı kullanırken F1 tuşuna basarız da kocaman bir Web sayfası çıkar ya karşımıza? İşte o tarz sayfaları çok rahatlıkla hazırlayabiliriz Markdown ile. Pandoc ve Typora ikilisi yardımıyla bu işleri tek bir .md dosyası ile halledebilir, istediğimiz formatta çıktı üretebiliriz.
Doküman Web Sayfası
Şu an bu kitabı okuduğunuz gibi bir arayüzden farklı olarak onlarca çeşit arayüz kullanarak siz de bu şekilde bir yardım Web sitesi oluşturabilirsiniz. Aşağıdaki örneklerini vereceğim Web sitelerinden daha fazlası var ama ben sizlere en yaygın olanlarını sunacağım.
| Site | Açıklama |
|---|---|
| Read The Docs | Github üzerinde .md dosyalarını barındırıyor ve bu site yardımıyla da bizim kitabımıza benzer tasarımlara sahip Web sitelerine dönüştürüyorsunuz. |
| MKDocs | Aynı prensiplere sahip bir başka site daha. Md uzantılı dosyalarla çalışıyor, .yaml uzantılı dosya yardımıyla sitenizin ayarlarını yapıyor ve oluşan Web sayfanızı istediğiniz yerde yayımlayabiliyorsunuz. |
| Docusaurus | Versiyon kontrol sistemi entegrasyonu da sağlayan bu site de kesinlikle ihtiyaçlarınızı karşılayacak niteliklere sahip. |
| VuePress | Arkasında Vue olan güçlü bir statik site oluşturucusu ve özellikle dokümantasyon oluşturmak için bire bir. |
| Jekyll | BorfirBora.Com sitesinden tutun da bir çok projemde kullandığım, öğrenmesi son derece kolay ve kullanışlı bir statik site oluşturucusu. Web sitesi bölümünde de konuştuğumuz gibi Github tarafından da kullanılıyor ve tamamen ücretsiz. |
Nihayet neler yapabileceğimiz konusuna bir nokta koyduk. Daha yazmak isterdim ama devamını sizin ilginize ve isteklerinize bırakıyorum. Her şeyi yazarsam, bana ne soracaksınız, değil mi?
Bir sonraki ünitemizde artık bu muazzam dile başlıyoruz.