Türkçe Markdown Rehberi
GitHub Repolarınızda fırtınalar estirip harika projeler yapsanız bile güzel bir “README.md” dosyanız olmadan kimseye gösteremezsiniz.
Markdown, basit sözdizimine sahip hafif işaretleme dilidir. Tasarımsal olarak sade ve yazımı çok basittir. Bu sayede kolay bir şekilde açıklama sayfaları ve HTML destekli sayfalar oluşturabilirsiniz.
Her zaman olduğu gibi kullanışlı olan ama her nasılsa yazılmaya fırsat bulunmamış, internet üzerinden popüler fakat ülkemiz topraklarına gelmekte zorlanmış başlıkları yazdığım makalelerden birindeyiz.
Yazıya başlamadan önce:
Veri bilimi ve makine öğrenmesi hakkında paylaşımlar yapıyorum, özellikle yararlı gördüğüm fakat insanların size anlatmadıkları şeyleri göstermeyi seviyorum, yeni gelecek yazılardan haberdar olmak için takip etmeyi unutmayın.
Bugünün konusu “MARKDOWN!!!”
Uzun uzadıya markdown şöyle harikadır, böyle kullanışlıdır, kullanmazsanız bu olur demek istemiyorum, hem kullanışlı bir “cheat sheet” hem de güzel bir readme dosyası nasıl yazılır, uygulaya uygulaya göreceğiz.
Sanırım dayanamayacağım bana izin verin bir iki cümle edeyim. Markdown o kadar harika ki, readme dosyalarında kullanıldığı gibi Jupyter Notebook’larınızı da güzelleştirmeye yarıyor. O kod bloklarının arasındaki hücrelerde yazılan yazıların hepsini markdown ile yapabileceksiniz.
Ders 1: Başlık At
Başlıklarımızı diyez işareti ile yapıyoruz ve bu şekilde uzayıp gidiyor.
Ders 2: Liste oluştur
- İlk girdi
- Ikinci girdi
“*, -,+” işaretleri ile de sırasız listeler oluşturabiliyoruz. Bu listeleri yazarken eğer indent (tab ile boşluk) bırakırsanız, liste içinde liste oluşturabilirsiniz.
3. Link bırak:
[Referans bir isim](https://www.gooogle.com)
Mesela bir örnek yapalım.
GitHub adresime [buradan](github.com/cobanov) ulaşabilirsiniz.
4. Görsel ekle:
Link vermekle hemen hemen aynı sadece ünlem işareti ile başlıyorsunuz.
5. Kod ekle:
` eklenecek kod örneği`
Markdown ile kod eklemek oldukça kolay bunun için ters tırnak kullanıyoruz. “AltGr + virgül” kombinasyonunu kullanabilirsiniz.
6. Yatay Ayraç
Bazen ayraç koymak okunabilirliği oldukça arttıran bir element olabilir, bu yüzden kullanmak isterseniz üç adet tire işareti koymanız yeterli.
7. Tablo yarat:
Tablo yaratmak harika, bu yüzden nasıl yapıldığını öğrenelim. İhtiyacımız olan şeyler tire işaretleri ve dik çizgi. Dik çizgi yapmak için “Ctrl + Alt + Tire işaret” kombinasyonunu kullanabilirsiniz.
8. Alıntı yap:
Bir büyüktür işareti atın ve yazmaya başlayın, alıntınız hazır.
9. Kalın ve italik yaz
Örnek bir çalışma yapalım
Bir readme dosyası içeriğinde bazı elementlere sahip olmalıdır.
- Başlık
- Başlarken
- Kurulum
- Gereklilikler
- Yazar
Çoğu readme dosyası için belirli bir şema vardır. Şimdi bu şemayı basit ve genel formda yazıyor olacağız.
Örnek Bir Readme Dosyası
# Keras-TensorboardBu repo tensorboard özelliklerini keras ile kullanmak için örnek çalışmalar içerir.
## Getting StartedOluşturulan bir yapay sinir ağında elde edilen parametreleri ve katmanların incelenmesi için kullanılan tensorboard'un keras ile nasıl çalıştırılacağı adına örnek bir proje.Ayrıca kapsamlı rehbere Deep Learning Türkiye Medium sayfasından ulaşabilirsiniz.
[Rehber Linki](https://medium.com/deep-learning-turkiye/tensorboard-başlangıç-rehberi-198ea522b01)
Burada projenizle alakalı yarı detaylı bir açıklama girmelisiniz. Projem şu amaçlara hizmet eden ve bu işlemleri şu yöntemle gerçekleştirirken bu tarz kütüphane ve frameworkleri şu dille yazılan bir proje ile çalıştırır.
### Prerequisites```
Python 3.x.x
TensorFlow
Keras
Numpy
```
Burası biraz daha teknik olacak fakat öğrenmekte yarar var, reponuzun içerisinde projenizi çalıştırmak için gerekli olan kütüphaneleri ‘requirements.txt’ dosyasında veriririz ki arkadaşlar hızlıca terminal üzerinden eksik içeriklerin kurulumlarını yapabilsinler, aynı zamanda bu dosyanın içeriğini de ufak bir blokta readme dosyasına da ekleriz.
Bunun için markdownda kod eklemeye yarayan tırnakları kullanıyoruz.
``` ``` bu üç tırnak kod ekleme bölümünü temsil etmektedir.
### Installing
Gerekli kütüphaneler kurulduğunda komut satırı üzerinden `python kerasboard.py` komutu ile çalıştırılabilir.Model eğitimi tamamlandıktan sonra programın son çıktısı komut satırında çalıştırılarak tarayıcıda `localhost:6006` adresinde grafikler gözlenebilir.
Yazdığınız proje kurulumda eğer detay bir bilgi veya zorluk içeriyorsa çalıştırmak için kısa bir bilgilendirme yazabilirsiniz, ben genelde ekran görüntüsünün kaydını alarak basit bir gif hazırlıyorum, bu projeye çok güzel bir hava katıyor.
Giflerde ayni resimler gibi ![]() Kombinasyonuyla ekleyebilirsiniz.
Opsiyonel
Eğer bir makine öğrenmesi modeli geliştirdiyseniz modelinize ait parametreleri readme dosyasında yazmanızda yarar var.
Hangi modelin kullanıldığı, hangi veri setinin kullanıldığı ve diğer hiper parametreleri verebilirsiniz.
### Notes:
Path error alındığı takdirde, C: dizini altında *tmp* adlı klasör oluşturun.## Model:
* Data: MNIST
* Tür: ConvNet
* Optimizer: Adam
* Loss: Categorical Crossentropy## Authors* **Mert Çobanoğlu** - [cobanov](https://github.com/cobanov)## LicenseThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
Burada kendinizden bahsedebilir, iletişim adresinizi isterseniz paylaşabilirsiniz, projeye destek veren arkadaşları Contributor alanında gösterebilirsiniz.
Eğer açık kaynak bir lisansa sahipseniz burada bu lisansının hakkında bilgilendirme yapabilirsiniz.
Çalışmalarımı ve yazdığım readme dosyalarını github hesabımdan inceleyebilirsiniz.
Linkedin: Mert Çobanoğlu, Github: cobanov
