MkDocs

MkDocs, Markdown dosyalarını tam statik HTML web sitelerine dönüştüren bir dokümantasyon oluşturucusudur. İçeriğinizi, herkesin birkaç dakika içinde öğrenebileceği basit bir metin formatı olan Markdown ile yazarsınız. MkDocs daha sonra bu dosyaları işler ve gezinme, arama ve güzel tasarıma sahip tam bir web sitesi oluşturur.

Araç, yazarken size canlı önizlemeler gösteren yerleşik bir geliştirme sunucusu içerir. Bu, değişiklikleri tarayıcınızı manuel olarak yenilemeden hemen görmenizi sağlar. MkDocs, iki yerleşik tema ile birlikte gelir ve popüler Material for MkDocs gibi birçok topluluk tarafından oluşturulan temayı destekler.

MkDocs statik dosyalar oluşturduğundan, dokümantasyonunuz hızlı yüklenir ve karmaşık sunucu ayarları veya veritabanları gerektirmeden her yerde barındırılabilir.

MkDocs ile başlaması basittir:

• Bilgisayarınıza Python yüklü değilse yükleyin. MkDocs'un düzgün çalışması için Python 3.8 veya daha yeni bir sürüm gereklidir.

• pip install mkdocs komutunu kullanarak MkDocs'u yükleyin. Bu, ihtiyacınız olan her şeyi indirir ve kurar.

• mkdocs new my-project komutunu çalıştırarak yeni bir proje oluşturun. Bu, yapılandırma dosyası ve örnek dokümantasyon içeren temel bir yapıya sahip bir klasör oluşturur.

• Dokümantasyonunuzu docs klasörü içindeki Markdown dosyalarında yazın. Her dosya web sitenizde bir sayfa olur.

• mkdocs serve komutunu çalıştırarak çalışmanızı önizleyin. Bu, genellikle http://127.0.0.1:8000 adresinde yerel bir sunucu başlatır ve dokümantasyonunuzu gerçek zamanlı olarak görmenizi sağlar.

• mkdocs build komutunu kullanarak son web sitenizi oluşturun. Bu, yayınlamaya hazır tüm HTML dosyalarını içeren site klasörü oluşturur.

• Dokümantasyonunuzu GitHub Pages veya herhangi bir web barındırma servisine mkdocs gh-deploy komutuyla GitHub için veya site klasörü içeriğini yükleyerek dağıtın.

• Markdown tabanlı dokümantasyon yazımı

• Otomatik tarayıcı yenilemeli canlı önizleme

• Yerleşik ve üçüncü taraf tema desteği

• Tek YAML yapılandırma dosyası

• Genişletilmiş işlevsellik için eklenti sistemi

• Hızlı statik HTML siteleri oluşturur

• Dış hizmetler olmadan entegre arama

• Her yerde dağıtım (GitHub Pages, Netlify, vb.)

• Açık kaynak ve tamamen ücretsiz

• Aktif topluluk desteği ve geliştirme