GitBook, dokümantasyon siteleri veya şirket wiki’leri oluşturmanıza izin veren bir platformdur. Koddan API’lere ve bir yazılım ürününün nasıl kullanılacağına kadar her türlü şeyi belgelemek için kullanabilirsiniz.
GitBook, GitHub depolarına benzer bir işlem kullanır. Dokümantasyonun ana kopyası, “ana” kopya görevi görür. Daha sonra “dallara” benzeyen “taslaklar” oluşturabilirsiniz.
Bu işlem, çakışmaları yönetirken veya önlerken birçok kullanıcının tek bir belgeleme sitesinde çalışmasına olanak tanır. Ayrıca, farklı dallardaki değişikliklerin siz bunları birleştirmeden önce bir inceleme sürecinden geçmesine olanak tanır.
GitBook’u Kullanmaya Nasıl Başlanır?
Birkaç GitBook fiyatlandırma planı arasından seçim yapabilirsiniz. Fiyatlandırma, GitBook’u açık kaynaklı projeler, kişisel kullanım veya özel ekip işbirliği için kullanıp kullanmadığınıza bağlı olacaktır. Açık kaynaklı projeler için kullanıyorsanız GitBook’u kullanmak ücretsizdir.
GitBook , web’de yazmak veya belgelemek için birçok avantajı olan popüler bir biçimlendirme dili olan Markdown’ı destekler.
GitBook ayrıca kodu barındırmak, depolamak ve düzenlemek için bir platform olan GitHub ile entegre olur . GitHub kimlik bilgilerinizi kullanarak oturum açarak GitBook hesabınızı doğrudan GitHub hesabınıza bağlayabilirsiniz.
GitBook’a kaydolun. Kendi GitHub hesabınız varsa GitHub ile Kaydolun seçeneğine tıklayabilirsiniz .
Web sitesindeki GitBook sayfasında oturum açın
Oturum açtıktan sonra GitBook sizi yeni bir dahili wiki’ye yönlendirecektir. Ayrıca vikinizi bazı örnek içeriklerle önceden dolduracaktır.
GitBook’ta Dahili Wiki Sayfası
GitBook Arayüzüne Genel Bakış
GitBook, dokümantasyon sitenizi oluşturmanıza ve sitenizde değişiklik yapmanıza izin veren çeşitli işlevlere sahiptir.
Üst panel, yeni taslaklar oluşturmanıza, değişiklik geçmişini görüntülemenize veya diğer tartışmaları veya ekleri görüntülemenize olanak tanır.
GitBook arayüzünün üst paneli
En soldaki kenar çubuğu, birden çok boşluk oluşturmanıza olanak tanır. Dokümantasyon alanlarınızı ayırıp düzenleyebilmeniz için farklı projeler için ayrı alanlar kullanabilirsiniz. Kenar çubuğunu genişletebilir veya kapatabilirsiniz.
GitBook’ta Spaces paneli
Sol panel, dokümantasyon sitesi için bir menü görevi görür. Dokümantasyon sitenizdeki sayfaları görüntüleyebilir ve bunu gruplar ve iç içe sayfalar oluşturmak için kullanabilirsiniz. Ayrıca, sağlanan bağlantıları kullanarak sitede gezinebilirsiniz.
GitBook Arayüzündeki Sayfalar Sütunu
Alt panel, sürüm kontrol süreci için hayati önem taşıyan düğmeler içerir. Taslağınız için bir ad ekleyebilir, bir değişikliği birleştirebilir veya değişikliği incelemeye gönderebilirsiniz.
GitBook Interace’de alt panel
Yeni Taslak Nasıl Oluşturulur
Yeni bir Değişiklik Talebi oluşturarak ve içinde değişiklikler yaparak yeni bir taslak oluşturabilirsiniz.
Üst panelde İstekleri Değiştir seçeneğine tıklayın .
GitBook’ta Değişiklik İsteği Oluştur düğmesi
Sağ tarafta görünen yeni panelde Taslak sekmesine tıklayın. Bu size tüm aktif taslaklarınızı gösterecektir.
GitBook’ta Değişiklik İsteği Oluştur düğmesi
Buradan, açmak için mevcut bir taslağı tıklayabilirsiniz. Yeni bir taslak oluşturmak için Yeni değişiklik isteği’ni tıklayın ve sayfanın yüklenmesinin bitmesini bekleyin.
Alt panelde, Bir Konu Girin’i tıklayın . Bu, yeni taslağa bir ad verebileceğiniz bir pencere açacaktır. Örneğin, Yeni Sayfa – Kod Tabanı Nasıl Kurulur .
GitBook’ta ad taslağı
Sayfalar ve Gruplar Nasıl Oluşturulur
Bir taslağınız olduğunda, belgelerde değişiklik yapmaya başlayabilirsiniz. GitBook, değişikliklerinizi taslağın içinde saklar, böylece ana kopyayı etkilemezler. Sayfaları ve sayfa gruplarını eklemek için sol kenar çubuğunu kullanabilirsiniz.
Kenar çubuğunun altındaki Yeni Sayfa bağlantısına tıklayarak ve açılır menüden Yeni belge sayfası’nı seçerek yeni bir sayfa oluşturun. Alternatif olarak, mevcut bir sayfanın altına gelip mavi artı düğmesine tıklayabilirsiniz.
GitBook’ta yeni sayfa eklemek için Artı düğmesi
Yeni bir Sayfa Grubu oluşturmak için Yeni Sayfa’ya tıklayın ve açılır menüden Yeni grup seçeneğini seçin.
GitBook’ta yeni grup eklemek için Artı düğmesi
Sayfanın veya grubun yanındaki üç noktayı tıklayıp Yeniden Adlandır’ı seçerek sayfayı yeniden adlandırabilirsiniz .
GitBook’ta Sayfayı Yeniden Adlandır düğmesi
Yeni sayfanızı doldurmak için içerik eklemeye başlayın. Metin veya başlıklar gibi basit içerikler ekleyebilirsiniz. GitBook ayrıca resimler, dosya ekleri, tablolar, sekmeler veya kod parçacıkları gibi diğer içerik bloklarını eklemenize olanak tanır. YouTube yerleştirmeleri veya Google Dokümanlar içeriği gibi diğer entegrasyonları ekleme seçeneği de vardır.
GitBook’ta açık sayfa
Taslağınız ile orijinal ana belge kopyası arasındaki farkları görmek için alt paneldeki Fark görünümü düğmesine tıklayın .
Farkı GitBook’ta Görüntüle
İçeriğinizi yazmayı bitirdikten sonra, Birleştir , Gönder ve birleştir veya İnceleme için gönder seçeneğine tıklayabilirsiniz .
GitBook’ta Gönder veya Birleştir düğmesi
Dokümantasyon Sitesine Bağlantı Nasıl Oluşturulur
Paylaşım bağlantısına GitBook’un üst panelinden erişebilirsiniz. Bağlantıyı görüntüleyebilmek için taslağın dışında olmanız ve ana belge kopyasını görüntülemeniz gerekir.
Varsayılan olarak, dokümantasyon sitenizin görünürlüğü “liste dışı”dır. Bu, dokümantasyon sitesine arama motorları aracılığıyla değil, özel bir bağlantı kullanarak erişebileceğiniz anlamına gelir. Üst panelde, Liste Dışı düğmesine tıklayın.
Açılır menüden istediğiniz görünürlük ayarlarını seçin. GitBook’un belirli görünürlük ayarlarını kilitleyebileceğini ve bunlara erişmek için yükseltmeniz gerekebileceğini unutmayın.
GitBook Erişim Bağlantısı Açılır Menüsü
Görünürlük ayarları listesinin altında, dokümantasyon sitenizi kullanacak diğer kullanıcılarla paylaşabileceğiniz bir bağlantı vardır. Başkalarıyla paylaşmak için bu bağlantıyı kopyalayın.
Bağlantının altında, Bağlantı ve etki alanı ayarları ‘nı tıklayın . Burası, özel bir alan adını bağlayabileceğiniz veya URL’nin bir bölümünü değiştirebileceğiniz yerdir. Özel bir etki alanı kullanıyorsanız, Gitbook’un DNS’inizi nasıl doğru şekilde yapılandıracağınızla ilgili belgelerini görüntüleyebilirsiniz.
GitBook Erişim Bağlantısı
GitBook Kullanarak Dokümantasyon Oluşturma
GitBook, belgeleme sitelerinde veya şirket wiki’lerinde işbirliği içinde oluşturmanıza ve bunlar üzerinde çalışmanıza olanak tanır. GitBook, bir ana kopyayı kontrol etmek ve herhangi bir çakışmayı yönetmek için GitHub’dan dallar ve birleştirme gibi kavramlar ödünç alır.
Kendi bireysel değişikliklerinizi belgelere eklemek için yeni bir taslak oluşturabilirsiniz. Taslak içerisinde içerikte değişiklikler yapabileceğiniz gibi yeni sayfalar veya sayfa grupları da ekleyebilirsiniz. Değişikliklerinizi yapmayı bitirdikten sonra, bunları birleştirebilir veya inceleme için gönderebilirsiniz.
Java kodunuz için dahili belgeler oluşturuyorsanız, Javadoc’u keşfetmek isteyebilirsiniz. Javadoc, Java kodunuzu otomatik olarak belgelemenizi sağlar.