Tuesday, March 3, 2015

Github Usulu Dokuman Yazmak, Markdown

Github uzerinde mesela README.md (ya da diger md ile biten) dosyalarinda markdown formati kullaniliyor, baslik icin #, altbaslik icin ##, maddeler (bullet) * ile, resim, baglanti eklemek cok basit, vs. Bu format kullanmasi muthis kolay bir format - sahsen itiraf edelim, birkac kez blogger'dan cikip tum blog'u markdown bazli olarak Github uzerinden yayinlamayi dusunduk, matematiksel formulleri servis tarafinda isleyip (MathJax gibi degil, o kullanici tarafinda isliyor, Javascript uzerinden) gosteren bir cozum uzerinde bile calismaktalar. Neyse, simdilik kodlarin dokumanlarini yazmak icin markdown kullaniyoruz. Fakat bu durumda dokumanin nasil gozukecegini, dokumani Github'a gondermeden nasil bilecegiz? Cunku git push zaman alir, uzaktaki bir makinadan (github.com) sayfa gostermek te zaman alir, bu isleri yerel makinada yapsak daha iyi olur.

Komut satiri araci grip faydali olabilir.

sudo pip install grip

Dokumani derlemek icin

grip README.md --export out.html

Artik out.html icinde markdown dokumaninin goruntusu var.

Not: Bir diger arac, markdown, pek iyi islemiyor, mesela ``` arasinda kod gostermeyi tam yapamiyor.

No comments: