GitBook, sizin ve ekibinizin dokümantasyon siteleri oluşturmanıza ve bunlar üzerinde işbirliği yapmanıza olanak tanıyan bir platformdur. GitBook bunu, dallanma ve birleştirme gibi sürüm kontrol kavramlarını kullanarak yapar.
Birçok ekip üyesi tek bir dokümantasyon sitesinde çalışabileceğinden, GitBook ayrı taslaklar oluşturmanıza ve yönetmenize olanak tanır. Mevcut taslağınız ile ana belge kopyası arasındaki farkları da görüntüleyebilirsiniz.
Viki sayfalarınıza ekleyebileceğiniz çeşitli blok türleri mevcuttur. Buna başlıklar, paragraflar, resimler, ipuçları, tablolar, kod blokları, dosya ekleri ve daha fazlası dahildir.
GitBook’ta İçerik Blokları Nasıl Eklenir?
Bir sayfaya eklemek için mevcut içerik bloklarının bir listesini görüntüleyebilirsiniz. Bunu sayfada herhangi bir yere tıklayıp çıkan artı simgesine tıklayarak yapabilirsiniz. Belirli bir içerik bloğunu doğrudan da arayabilirsiniz.
Markdown’ı kullanarak içerik ekleyebilirsiniz. Daha önce Markdown’u kullanmadıysanız, Markdown’a nasıl başlayacağınız hakkında daha fazla bilgi edinebilirsiniz . Ayrıca Markdown’ın neden bu kadar popüler olduğu hakkında daha fazla bilgi edinebilirsiniz .
Paragraf, Liste, Alıntı veya Kod Blokları Nasıl Eklenir?
Listeler, paragraflar, alıntılar, kod blokları veya diğer basit içerik blokları eklemek için açılır menüyü açın ve mevcut türler arasından seçim yapın.
Dokümantasyon sitenizdeki bir sayfada, içeriğinizi eklemek istediğiniz konumdaki artı düğmesine tıklayın.
Sayfadaki GitBook Plus düğmesi
Açılır menüden, farklı içerik seçeneklerini görüntülemek için listede gezinebilirsiniz.
Açılır menüde GitBook paragrafı
Buradan paragraf, kod bloğu, başlık veya alıntı gibi herhangi bir basit içerik türünü seçin. GitBook, seçtiğiniz biçime uyması için içeriği otomatik olarak değiştirecektir.
Bir sayfada madde işareti listesi, alıntı ve kod bloğu içeren GitBook
Görüntüler veya Dosya Ekleri Nasıl Eklenir?
Görüntü eklemek için, açılır menüyü kullanarak Görüntüler içerik bloğu seçeneğini seçin. Dosya eklemek için bunun yerine Dosya Ekle seçeneğini seçin. Ardından, yüklediğiniz resimleri ve dosyaları yönetmek için sağdaki paneli kullanabilirsiniz.
Dokümantasyon sitenizde bir sayfa açın. Kullanılabilir içerik blokları için açılır menüyü açmak üzere artı düğmesine tıklayın .
Görüntü Ekle öğesini seçin .
Açılır menüde GitBook görüntüleri seçeneği
Görüntülenen sağ panelde üç sekme vardır. Dosyalar sekmesi, kendi resim dosyanızı yüklemenizi sağlar . URL sekmesi , çevrimiçi bir görüntüye bağlantı vermenizi sağlar. Unsplash sekmesini de açabilirsiniz . Bu, ilişkilendirme gerektirmeyen mevcut fotoğrafları seçebileceğiniz yerdir.
GitBook’ta resimler sekmesini seçin
Bir resim ekledikten sonra, resmin sol üst köşesinde bulunan üç nokta düğmesini tıklayın. Bu, görüntüyü hizalayabileceğiniz veya silebileceğiniz bir açılır menü açar. Ayrıca resme bir başlık da verebilirsiniz.
GitBook’ta sayfadaki görüntüyü hizalama
Dosya eklemek için, imlecinizi dokümantasyon sitenizdeki bir sayfada herhangi bir yere getirin. İçerik bloğu türleri açılır menüsünü açmak için artı düğmesine tıklayın . Bu kez, dosya ekle seçeneğine tıklayın.
İçerik blokları açılır menüsündeki dosyalar seçeneği
Görüntü yerine herhangi bir dosya ekini yüklemenize izin veren benzer bir sağ panel görünecektir. Bilgisayarınızda yerel olarak depolanan bir dosyayı seçmek için Dosyalara gözat’a tıklayın .
GitBook’ta açılan dosyaları seçin paneli
Dosya listede görünecektir. Dosyaya tıklayın, GitBook açtığınız sayfada dosya eki ile bir içerik bloğu oluşturacaktır. Bu içerik bloğuna tıklandığında dosya eki indirilir.
GitBook’ta sayfada dosya
İpuçları Nasıl Eklenir?
Sayfanıza ipuçları da ekleyebilirsiniz. Tehlike için kırmızı, uyarı için turuncu, bilgi için mavi veya başarı için yeşil kullanmak için ipuçlarının simgesini değiştirebilirsiniz.
Bir ipucu eklemek için, mevcut içerik blokları için açılır menüyü açmak üzere artı düğmesine tıklayın.
İpucu öğesini seçin .
İçerik blokları açılır menüsündeki ipuçları seçeneği
Bu, sayfanıza bir ipucu ekleyecektir. Varsayılan olarak, ipucu türü “bilgidir” ve mavi bir simge içerir.
GitBook’taki sayfada varsayılan bilgi ipuçları
Simgeye tıklayarak ipucu türünü değiştirebilirsiniz. Bu, dört farklı ipucu türü arasında döngü oluşturacaktır.
Sayfada dört farklı ipucu türü
Tablolar Nasıl Eklenir?
Açılır listeden tablo seçeneğini belirleyerek tablo ekleyebilirsiniz . Sayfada tablonuz olduğunda, yeni satırlar veya sütunlar ekleyebilirsiniz. Ayrıca sütunların adlarını ve veri türlerini değiştirebilir ve tablonun içindeki verileri değiştirebilirsiniz.
Kullanılabilir içerik blokları için açılır menüyü açmak üzere artı düğmesine tıklayın .
Tablo öğesini seçin .
İçindekiler açılır menüsünde tablo seçeneği
Tablodaki bir sütunun başlığına tıklayın. Bu, seçilen sütunun adını değiştirebileceğiniz daha küçük yeni bir menü açacaktır. Bu menü aynı zamanda seçilen sütunu silmenizi veya gizlemenizi sağlar. Belirli sütun veri türleri için, içeriği sütunun içinde de hizalayabilirsiniz.
GitBook’ta tablo sütunları mini menüsü
Varsayılan olarak, sütunlar için seçilen veri tipi “Metin”dir. Veri tipini değiştirmek için T sembollü butona tıklayın . Bir sayı, onay kutusu, açılır menü, dosya eki, derecelendirme veya daha fazlasıyla değiştirebilirsiniz.
GitBook’taki tablodaki Sütun DataTypes mini menüsü
Tablonun sol üst köşesine yakın altı nokta simgesine tıklayın . Burada yeni sütunlar ve satırlar ekleyebilir veya tüm tabloyu silebilirsiniz. Ayrıca belirli sütunları gizleyebilir veya gösterebilir ya da tablonun diğer özelliklerini değiştirebilirsiniz.
GitBook tablo özellikleri menüsü
Sayfa Bağlantı Blokları Nasıl Eklenir?
Sayfa bağlantı blokları, sayfadaki tüm satırı kaplayan bağlantılardır. Bağlantıyı eklediğinizde, birileri tıkladığında açılacak sayfaya bağlantı vermelisiniz.
Kullanılabilir içerik blokları için açılır menüyü açmak üzere artı düğmesine tıklayın .
Sayfa Bağlantısına tıklayın .
İçindekiler açılır menüsündeki Sayfa Bağlantısı seçeneği
Yeni açılır menüden bağlantı oluşturduğunuz sayfayı seçin.
GitBook’ta sayfa bağlantı seçenekleri
Sayfa bağlantınız, sayfada bir bloğun içinde görünecektir.
GitBook’taki sayfadaki sayfa bağlantısı
Dokümantasyon için GitBook’u Kullanma
GitBook, dallanma ve birleştirme gibi sürüm kontrol kavramlarını kullanan bir dokümantasyon aracıdır. Bu, ekibin birden fazla üyesinin belgeler üzerinde aynı anda çalışmasına olanak tanır. Ayrıca meydana gelen herhangi bir çatışmayı yönetmeye yardımcı olur.
Bir sayfaya her türlü içerik bloğunu ekleyebilirsiniz. İçeriğinizi yeniden biçimlendirmek için başlıkları, paragrafları, kod bloklarını veya madde işaretlerini kullanabilirsiniz. Bir tablonun sütunlarını özelleştirmenin yanı sıra ipuçlarının ipucu tipini, mesajını ve simge tipini değiştirebilirsiniz.
Dosyalar sekmesi, siteye yüklediğiniz resimleri ve dosya eklerini yönetmenize olanak tanır. Sayfa Bağlantıları, kullanıcıların kolayca fark edebileceği büyük bağlantılar oluşturmanıza olanak tanır.
Go dili ile ilgili belgeler oluşturuyorsanız, Godoc’u kullanabilirsiniz. Godoc, Go kodunuzu otomatik olarak belgelemenizi sağlar.