Home-theater-designers
GitBook, dokümantasyon siteleri veya şirket wikileri 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 süreç kullanır. Belgelerin ana kopyası bir 'ana' kopya görevi görür. Daha sonra 'dallara' benzer 'taslaklar' oluşturabilirsiniz.
eski metin mesajları nasıl görüntülenir
Bu süreç, birçok kullanıcının çakışmaları işlerken veya önlerken tek bir belge 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ç arasından seçim yapabilirsiniz GitBook fiyatlandırması planlar. Fiyatlandırma, GitBook'u açık kaynak projeleri, kişisel kullanım veya özel ekip işbirliği için kullanıp kullanmadığınıza bağlı olacaktır. Açık kaynak projeleri için kullanıyorsanız GitBook'u kullanmak ücretsizdir.
GitBook destekler Markdown, birçok faydası olan popüler bir biçimlendirme dili Web'de yazmak veya belgelemek için.
GitBook ayrıca şunlarla da bütünleşir: GitHub, kod barındırma, depolama ve düzenleme platformu . 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, üzerine tıklayabilirsiniz. GitHub'a Kaydolun .
- Oturum açtıktan sonra GitBook sizi yeni bir dahili wiki'ye yönlendirecektir. Ayrıca wikinizi bazı örnek içeriklerle önceden dolduracaktır.
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.
- 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.
- Sol panel, dokümantasyon sitesi için bir menü görevi görür. Belge sitenizdeki sayfaları görüntüleyebilir ve bunu gruplar ve iç içe sayfalar oluşturmak için kullanabilirsiniz. Ayrıca verilen bağlantıları kullanarak sitede gezinebilirsiniz.
- Alt panel, sürüm kontrol süreci için hayati önem taşıyan düğmeleri 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.
Yeni Taslak Nasıl Oluşturulur
Yeni bir Değişiklik Talebi oluşturarak ve içinde değişiklik yaparak yeni bir taslak oluşturabilirsiniz.
kendi minecraft modunu nasıl yaparsın
- Üst panelde, üzerine tıklayın İstekleri Değiştir .
- Sağ tarafta görünen yeni panelde, Taslak sekme. Bu size tüm aktif taslaklarınızı gösterecektir.
- Buradan, açmak için mevcut bir taslağa tıklayabilirsiniz. Yeni bir taslak oluşturmak için tıklayın Yeni değişiklik isteği ve sayfanın yüklenmesinin bitmesini bekleyin.
- Alt panelde, üzerine tıklayın Bir Konu Girin . Bu, yeni taslağa bir ad verebileceğiniz bir pencere açacaktır. Örneğin, Yeni Sayfa - Codebase Nasıl Kurulur .
Sayfalar ve Gruplar Nasıl Oluşturulur
Bir taslağınız olduğunda, belgelerde değişiklik yapmaya başlayabilirsiniz. GitBook, değişikliklerinizi taslak içinde saklar, böylece ana kopyayı etkilemezler. Sayfalar ve sayfa grupları eklemek için sol kenar çubuğunu kullanabilirsiniz.
uygulamalar sd karta nasıl atılır
- simgesine tıklayarak yeni bir sayfa oluşturun. Yeni sayfa kenar çubuğunun altındaki bağlantı ve Yeni belge sayfası açılır menüden. Alternatif olarak, mevcut bir sayfanın altında gezinebilir ve mavi artı buton.
- Yeni bir Sayfa Grubu oluşturmak için üzerine tıklayın. Yeni sayfa öğesini seçin ve Yeni Grup açılır menüden seçenek.
- Sayfanın veya grubun yanındaki üç noktayı tıklayarak ve öğesini seçerek sayfayı yeniden adlandırabilirsiniz. Yeniden isimlendirmek .
- 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 başka içerik blokları eklemenize de olanak tanır. YouTube yerleştirmeleri veya Google Dokümanlar içeriği gibi diğer entegrasyonları ekleme seçeneği de vardır.
- Tıkla Fark görünümü taslağınızla orijinal ana belge kopyası arasındaki farkları görüntülemek için alt paneldeki düğmesine basın.
- İçeriğinizi yazmayı bitirdikten sonra, üzerine tıklayabilirsiniz. Birleştirmek , Gönder ve birleştir , veya İnceleme için gönder .
Dokümantasyon Sitesine Bağlantı Nasıl Oluşturulur
Paylaşım bağlantısına GitBook'un üst panelinden ulaşabilirsiniz. Bağlantıyı görüntüleyebilmek için taslaktan çıkmış 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, üzerine tıklayın. Liste dışı buton.
- 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ükseltme yapmanız gerekebileceğini unutmayın.
- 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, tıklayın Bağlantı ve alan ayarları . 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, görüntüleyebilirsiniz Gitbook'un belgeleri DNS'nizi nasıl doğru bir şekilde yapılandıracağınız hakkında.
GitBook Kullanarak Belge Oluşturma
GitBook, işbirliği içinde belge siteleri veya şirket wiki'leri oluşturmanıza ve bunlar üzerinde çalışmanıza olanak tanır. GitBook, ana kopyayı kontrol etmek ve herhangi bir çakışmayı yönetmek için GitHub'dan şubeler ve birleştirme gibi kavramları ödünç alır.
Belgelere kendi bireysel değişikliklerinizi eklemek için yeni bir taslak oluşturabilirsiniz. Taslak içinde içerikte değişiklikler yapabilir, yeni sayfalar veya sayfa grupları ekleyebilirsiniz. Değişikliklerinizi yapmayı bitirdikten sonra, bunları birleştirebilir veya incelemeye gönderebilirsiniz.
Java kodunuz için dahili belgeler oluşturuyorsanız, Javadoc'u keşfetmek isteyebilirsiniz. Javadoc, Java kodunuzu otomatik olarak belgelemenizi sağlar.