文檔工具GitBook使用指南

　　　　　　　　　　　　　　　　　　　文檔工具GitBook使用指南

　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　作者：尹正傑

版權聲明：原創作品，謝絕轉載！否則將追究法律責任。

 

 

　　

 

一.安裝Gitbook

1>.安裝nodejs

　　較新版本的gitboot關於左側導航欄使用了ajax技術，導致使用gitboot必須得基於HTTP協議，它不像舊版本默認支持本地文件訪問，即不能雙擊打開Markdown文件，因此本篇博客安裝的nodejs版本偏低。

　　nodejs下載地址：
　　　　https://nodejs.org/download/release/v6.14.1/

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管理工具的配置信息喲~

3>.查看Gitbook的幫助信息

C:\Users\yinzhengjie>gitbook -V

 

二.Gitbook的基本使用

1>.初始化GitBook

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


溫馨提示：
　　如下圖所示的兩個文件可不是平白無故生成的，他們都有各自的作用：
　　　　SUMMARY.md:
　　　　　　目錄總綱，即里面只記錄目錄對應的文件名稱，並不存儲真實數據。
　　　　README.md:
　　　　　　用於介紹的文件。

　　上面介紹了2個文件的作用，您打開SUMMARY.md文件會發現默認就有對README.md的映射關系，推薦您在初始化目錄后，新建一個文件目錄用來專門存儲您的筆記，而后使用SUMMARY.md映射對應的Markdown文件即可。

 

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版本后再進行編譯操作。

 3>.生成PDF和mobi電子書

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

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

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

 

 

 

三.博主推薦閱讀

    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