Gitbook
Gitbook Projeleri ve otomatik senkronizasyon testleri için açıldı.
Gitbook Kurulumu
Bunu global olarak kurun ve gitbook komutuna sisteminizin herhangi bir yerinden erişebileceksiniz.
$ npm install -g gitbook-cli
Not: gitbook komutunun amacı, sürümünden bağımsız olarak kitabınızda belirttiğiniz (veya en sonuncusu) GitBook sürümünü yüklemek ve çalıştırmaktır. GitBook CLI yalnızca GitBook'un >=2.0.0
sürümlerini destekler.
gitbook-cli GitBook’un sürümlerini ~/.gitbook’ta saklarsanız, GITBOOK_DIR ortam değişkenini başka bir dizini kullanacak şekilde ayarlayabilirsiniz.
Nasıl kurulur?
$ npm install -g gitbook-cli
Bu nasıl kullanılır?
GitBook’u çalıştırın
gitbook build, gitbook serve komutunu çalıştırın (ayrıntılar için GitBook belgelerini okuyun).
Kullanılabilir tüm komutları aşağıdakileri kullanarak listeleyin:
$ gitbook help
eğitim kuralları
normal olarak GitBook CLI, kitap yapılandırmasından yararlanmak için gitbook--gitbook
seçeneğini kullanarak belirli bir sürümü zorlayabilirsiniz:
$ gitbook build ./mybook --gitbook=2.0.1
ve bu sürümdeki mevcut komutları aşağıdakileri kullanarak listeleyin:
$ gitbook help --gitbook=2.0.1
Sürümleri yönet
Kurulu sürümleri listeleyin:
$ gitbook ls
NPM’deki mevcut sürümleri listeleyin:
$ gitbook ls-remote
Belirli bir sürümü yükleyin:
$ gitbook fetch 2.1.0
veya ön yayın
$ gitbook fetch beta
En son sürüme güncelle
$ gitbook update
Gitbook Book.json’u Kullanma
Gitbook bir kitabı derlediğinde, onu kitabın kaynak kodunun üst düzey dizininde okuyacaktır.
İçerik yönetimi
gitbook.com:4000 üzerinde /opt klasöründeki dosyaların nasıl senkronize edileceğini ve yönetileceğini gösterir.
Bu projede gitlab-ci.yml üzerinde copy komutu olarak scp -r
kullanılmıştır.
Kopyala komutu şu şekilde çalışır:
scp -r ./archive/ root@gitbook.com:/opt/gitbook/archive/"$CI_PROJECT_NAME".md
Bu komutta scp -r
den sonraki ilk satır kendi klasöründeki dosyayı belirtir ve bu dosyanın tüm içeriğini almak istiyorsak dosya adını yazmamız yeterlidir.
@
işaretinden önceki ikinci satır, hangi kullanıcının uzak linux’a bağlanacağını belirtir. @
uzak linux klasörünün yolunu belirttikten sonra.
$CI_PROJECT_NAME".md
bölümünde oluşturulan readme.md
dosyasının ismini proje ismi olarak belirleyip ona göre gönderiyoruz.
Kopyalama ve senkronizasyon işlemlerinden sonra
Gitbook linux bağlanır ve dosyaların oluşturulduğu /opt/gitbook
klasörünün altına gidilerek komutlar sırayla çalıştırılır:
gitbook build
cp -R /opt/gitbook/SUMMARY.md /opt/gitbook/README.md
gitbook build
işlemi ile aktarılan dosyaların summary.md
üzerinde senkronize edilmesini ve otomatik olarak ayarlanmasını sağlıyoruz.
cp -R
komutu ile özet.md’deki değişikliklerin giriş ile senkronize olmasını sağlıyoruz.
gitbook serve
komutu sayesinde tekrar gitbook
u çalıştırıyoruz.