GitBook, sizin ve ekibinizin dokümantasyon siteleri oluşturmasına ve bu sitelerde işbirliği yapmasına 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 belge 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 eklemeniz için ç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ıklayarak ve üzerine tıklayarak yapabilirsiniz. artı görünen sembol. Ayrıca belirli bir içerik bloğunu doğrudan arayabilirsiniz.

Markdown'ı kullanarak içerik ekleyebilirsiniz. Markdown'ı daha önce kullanmadıysanız, hakkında daha fazla bilgi edinebilirsiniz.

instagram viewer
Markdown'a nasıl başlanır. Ayrıca hakkında daha fazla bilgi edinebilirsiniz Markdown neden bu kadar popüler.

Paragraflar, Listeler, Alıntılar 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.

  1. Dokümantasyon sitenizdeki bir sayfada, artı İçeriğinizi eklemek istediğiniz konumdaki düğmesine basın.
  2. Farklı içerik seçeneklerini görüntülemek için açılır menüden listeyi kaydırabilirsiniz.
  3. Buradan paragraf, kod bloğu, başlık veya alıntı gibi herhangi bir basit içerik türünü seçin. GitBook, içeriği seçtiğiniz formata uyacak şekilde otomatik olarak değiştirecektir.

Resim veya Dosya Ekleri Nasıl Eklenir

Resim eklemek için açılır menüyü kullanarak Görüntüler içerik engelleme seçeneği. Dosya eklemek için, Dosya Ekle yerine seçenek. Ardından, yüklediğiniz resim ve dosyaları yönetmek için sağdaki paneli kullanabilirsiniz.

  1. Dokümantasyon sitenizde bir sayfa açın. Tıkla artı Mevcut içerik blokları için açılır menüyü açmak için düğmesine basın.
  2. Seçme Resim Ekle.
  3. Görünen sağ panelde üç sekme vardır. bu Dosyalar sekmesi kendi resim dosyanızı yüklemenizi sağlar. bu URL sekmesi, çevrimiçi bir görüntüye bağlantı vermenizi sağlar. Ayrıca açabilirsiniz Sıçramayı kaldır sekme. Bu, atıf gerektirmeyen mevcut fotoğrafları seçebileceğiniz yerdir.
  4. Bir resim ekledikten sonra, üzerine tıklayın. üç nokta resmin sol üst köşesinde bulunan düğme. Bu, görüntüyü hizalayabileceğiniz veya silebileceğiniz bir açılır menü açacaktır. Ayrıca resme bir başlık da verebilirsiniz.
  5. Dosya eklemek için imlecinizi belge sitenizdeki bir sayfada herhangi bir yere getirin. Tıkla artı içerik blok türleri açılır menüsünü açmak için düğmesine basın. Bu sefer tıklayın dosya ekle seçenek.
  6. Bir resim yerine herhangi bir dosya ekini yüklemenize izin veren benzer bir sağ panel görünecektir. Tıklamak Dosyalara göz atın Bilgisayarınızda yerel olarak depolanan bir dosyayı seçmek için
  7. Dosya listede görünecektir. Dosyaya tıklayın ve GitBook, açtığınız sayfada dosya ekiyle bir içerik bloğu oluşturacaktır. Bu içerik bloğuna tıklamak dosya ekini indirecektir.

İpuçları Nasıl Eklenir

Sayfanıza ipuçları da ekleyebilirsiniz. İpuçlarının simgesini tehlike için kırmızı, uyarı için turuncu, bilgi için mavi veya başarı için yeşil kullanacak şekilde değiştirebilirsiniz.

  1. Bir ipucu eklemek için, üzerine tıklayın. artı Mevcut içerik blokları için açılır menüyü açmak için düğmesine basın.
  2. Seçme İpucu.
  3. Bu, sayfanıza bir ipucu ekleyecektir. Varsayılan olarak ipucu türü "bilgi"dir ve mavi bir simge içerir.
  4. Simgeye tıklayarak ipucu türünü değiştirebilirsiniz. Bu, dört farklı ipucu türü arasında dolaşacaktır.

Tablolar Nasıl Eklenir

seçerek tablolar ekleyebilirsiniz. masa açılır listeden seçenek. 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 tablo içindeki verileri değiştirebilirsiniz.

  1. Tıkla artı Mevcut içerik blokları için açılır menüyü açmak için düğmesine basın.
  2. Seçme Masa.
  3. Tablodaki bir sütunun başlığına tıklayın. Bu, seçilen sütunun adını değiştirebileceğiniz daha küçük bir menü açacaktır. Bu menü ayrıca seçili sütunu silmenizi veya gizlemenizi sağlar. Belirli sütun veri türleri için, sütun içindeki içeriği de hizalayabilirsiniz.
  4. Varsayılan olarak, sütunlar için seçilen veri türü "Metin"dir. ile düğmesine tıklayın. T veri türünü değiştirmek için sembol. Bunu bir sayı, onay kutusu, açılır menü, dosya eki, derecelendirme veya daha fazlasıyla değiştirebilirsiniz.
  5. Tıkla altı nokta simgesi tablonun sol üst köşesine yakı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.

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, birisi tıkladığında açılacak olan sayfaya bağlantı vermeniz gerekir.

  1. Tıkla artı Mevcut içerik blokları için açılır menüyü açmak için düğmesine basın.
  2. Tıklamak Sayfa Bağlantısı.
  3. Yeni açılır menüden, bağlantı verdiğiniz sayfayı seçin.
  4. Sayfa bağlantınız, sayfada bir blok içinde görünecektir.

Belgeler için GitBook'u Kullanma

GitBook, dallanma ve birleştirme gibi sürüm kontrol kavramlarını kullanan bir belgeleme aracıdır. Bu, ekibin birden fazla üyesinin aynı anda belgeler üzerinde çalışmasına izin verir. Ayrıca meydana gelen herhangi bir çatışmayı yönetmeye yardımcı olur.

Bir sayfaya her türden içerik bloğu 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 türünü, mesajını ve simge türünü 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 görebileceği büyük bağlantılar oluşturmanıza olanak tanır.

Go dili ile ilgili dokümantasyon oluşturuyorsanız, Godoc'u kullanabilirsiniz. Godoc, Go kodunuzu otomatik olarak belgelemenizi sağlar.