天天看點

文檔工具GitBook使用指南

                   文檔工具GitBook使用指南

                                 作者:尹正傑

版權聲明:原創作品,謝絕轉載!否則将追究法律責任。

  

一.安裝Gitbook

1>.安裝nodejs

  較新版本的gitboot關于左側導航欄使用了ajax技術,導緻使用gitboot必須得基于HTTP協定,它不像舊版本預設支援本地檔案通路,即不能輕按兩下打開Markdown檔案,是以本篇部落格安裝的nodejs版本偏低。

  nodejs下載下傳位址:
    https://nodejs.org/download/release/v6.14.1/      
文檔工具GitBook使用指南

2>.安裝Gitbook

C:\Users\yinzhengjie>npm install -g gitbook-cli          #安裝nodejs成功後,就可以直接線上安裝Gitbook啦~

在安裝Gitbook的時候,可能會出現如下圖所示的情況,這個時候可以考慮降低Gitbook的版本,即可成功,操作方法如下。
  npm config set registry https://registry.npm.taobao.org/
  gitbook uninstall 3.2.3
  gitbook fetch 3.0.0

如果你有VPN的話應該不會遇到和我一樣尴尬的情況,可以更換回npm官方倉庫源,操作如下所示:
  npm config set registry http://www.npmjs.org

溫馨提示:
  可以使用"npm config list"檢視目前nodejs管理工具的配置資訊喲~      
文檔工具GitBook使用指南

3>.檢視Gitbook的幫助資訊

C:\Users\yinzhengjie>gitbook -V      
文檔工具GitBook使用指南

二.Gitbook的基本使用

1>.初始化GitBook

D:\yinzhengjie\gitbook>gitbook init        #如下圖所示,在你作業系統中選擇相應的路徑執行改指令,可以進行Gitbook的初始化操作


溫馨提示:
  如下圖所示的兩個檔案可不是平白無故生成的,他們都有各自的作用:
    SUMMARY.md:
      目錄總綱,即裡面隻記錄目錄對應的檔案名稱,并不存儲真實資料。
    README.md:
      用于介紹的檔案。

  上面介紹了2個檔案的作用,您打開SUMMARY.md檔案會發現預設就有對README.md的映射關系,推薦您在初始化目錄後,建立一個檔案目錄用來專門存儲您的筆記,而後使用SUMMARY.md映射對應的Markdown檔案即可。      
文檔工具GitBook使用指南

2>.生成HTML文檔

D:\yinzhengjie\gitbook>gitbook -V
CLI version: 2.3.2
GitBook version: 3.0.0

D:\yinzhengjie\gitbook>
D:\yinzhengjie\gitbook>gitbook build --gitbook=3.0.0      #編譯時指定Gitbook版本。需要注意的是,指定Gitbook版本要與安裝的版本一緻,否則他預設會去下載下傳最新的Gitbook版本後再進行編譯操作。      
文檔工具GitBook使用指南

 3>.生成PDF和mobi電子書

想要轉換成PDF以及mobi格式,需要我們單獨安裝Calibre軟體。

終端進入文檔目錄執行以下指令:
  gitbook pdf
  gitbook mobi

電子書封面圖檔:
  将圖檔重命名為cover.jpg放到電子書項目目錄即可,同僚需要注意以下幾項:
    (1)圖檔大小上線1800*2360像素;
    (2)沒有邊框;
    (3)清晰可見的書本标題;
    (4)任何重要的文字在小版本中應該可見;

      
文檔工具GitBook使用指南

三.部落客推薦閱讀

GitBook v3.2.3 使用教程
      https://www.bookstack.cn/read/gitbook-use-3.2.3/introduction.md

  标記語言MarkDown快速入門篇
    https://www.cnblogs.com/yinzhengjie/p/13514903.html      

當你的才華還撐不起你的野心的時候,你就應該靜下心來學習。當你的能力還駕馭不了你的目标的時候,你就應該沉下心來曆練。問問自己,想要怎樣的人生。

歡迎加入基礎架構自動化運維:598432640,大資料SRE進階之路:959042252,DevOps進階之路:526991186

繼續閱讀