【解決方案 十五】如何在內網通過GitBook打造電子書

這篇使用博客拖了很久了,其實在7月份左右成書之後就應該發出來防止之後自己再次使用忘掉的,由於迭代一直比較忙(自己一直比較懶),所以拖到現在纔開始動筆,趁着國慶節把這篇的事情搞了吧。其實這篇博客介紹的內容來源於工作上書的編寫,也是踩過不少坑,耽誤了很多時間,現在總結出來,除了防止自己忘,也希望能幫助大家。

適用範圍:想用MarkDown寫電子書,又想使用快捷的命令完成電子書的設置,而且內容還不能掛到外網上。

調研歷程

其實最初武哥就有電子書的推薦編寫工具,那就是Gitbook,首先給大家介紹下Gitbook,總結而言就是兩點:

  • GitBook 是一個基於 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 兩種語法格式,可以輸出 HTML、PDF、eBook 等格式的電子書。劃重點,通過Markdown語法,並且可以輸出爲常用任意格式。至於何爲MarkDown語法就不多做介紹了,這篇博客就是Markdown寫的hhh。
  • GitBook 不僅支持 Markdown 語法,還支持 Git 來進行版本控制。這個顧名思義,從GitBook裏就可以看的出來嘍。

而且Gitbook本身的配置文件支持電子書的多種設置,包括封面啊,錨點啊之類的。這些功能我還沒怎麼深入探索過。

其實網上推薦的方式是Gitbook+GitHub+GitBookEditor,所以最初本來也想採用這種方式,後來因爲是內部涉密文檔,所以不能通過GitHub,安全不通過,所以決定採用內網GibLab來代替。於是採用了Gitbook+GibLab+GitBookEditor的形式,但是在用了一段時間後發現:GitBookEditor也忒卡了,雖然功能厲害,但是需要翻牆使用,太麻煩了,就是這個編輯器耽誤了工作近一週的進度。於是通過一些調研,最終選定了用VSC,這玩意兒加載東西也太快了,完全不卡,而且提供一系列支持GitBook的擴展。於是最佳組合形成了:Gitbook+GibLab+VisualStudioCode+Calibre(Gitbook用來進行電子書的相關配置,GibLab用來存儲書籍和版本控制,VisualStudioCode用來進行MarkDown編輯,Calibre是轉換電子書的插件)。

最佳實踐

在選定了組合之後,就開始我們的最佳實踐吧:分爲以下幾個步驟,完成這幾個步驟就可以開寫了:

  • GitBook的下載與配置
  • GibLab的項目創建
  • VisualStudioCode的下載與配置
  • Calibre的安裝與配置

接下來詳細介紹下這幾個步驟。

GitBook的下載與配置

因爲 GitBook 是基於 Node.js,所以我們首先需要安裝 Node.js,從【 Node.js下載地址】,下載對應版本的Node.js。我這裏是64位的Windows系統,所以選擇當前最新的版本並下載:
在這裏插入圖片描述

現在安裝 Node.js 都會默認安裝 npm(node 包管理工具),所以我們不用單獨安裝 npm,打開命令行,執行以下命令安裝 GitBook:

npm install -g gitbook-cli

執行完成後,可以在本地創建一個文件夾使用命令來驗證下安裝是否成功:

gitbook init

在這裏插入圖片描述

命令執行完後,會多兩個文件,這兩個文件非常重要哦:

  • README.md 和大多數項目一樣哦,就是用來寫項目也就是書籍的扉頁的!
  • SUMMARY.md 用來配置書籍的目錄結構,和文件會關聯起來

有了這兩個文件之後就可以開始工作了。README.md這個文件就不必多說了,主要來看看SUMMARY.md這個文件:

# 目錄

* [世界地圖](README.md)  
* [第一章:中國地圖](中國地圖/README.md)  
  * [第1節:北京地圖](中國地圖/北京地圖.md)
  * [第2節:上海地圖](中國地圖/上海地圖.md)
* [第二章:美國地圖](美國地圖/README.md)

有幾點需要注意的地方:

  • 注意真實文件的文件名和圓括號裏的綁定並且圓括號裏顯示的是文件的層級關係,方括號裏的是顯示的名稱
  • 原括號裏的README.md用來標識本書的前言信息
  • 只要有父級節點就放置一個README.md的文件,這樣層級關係更加明顯
  • 子一級別應該比父級別節點縮進兩格

以上幾點是該文件我比較常用的使用習慣。配置好目錄結構後再次使用命令gitbook init自動初始化目錄配置的文件。
在這裏插入圖片描述

GitLab創建文本倉庫

其實GitLab和GitHub一樣,不過就是代碼和文本倉庫,創建也很簡單,直接創建一個項目然後配置好master和共同開發人員即可,就不詳細展開了。
在這裏插入圖片描述

VisualStudioCode的下載與配置

下載比較簡單,也在其它博客裏提到過,直接從這裏下載【VisualStudioCode下載地址】下載之後即可進行配置和鏈接GitLab
在這裏插入圖片描述
下載完成後直接安裝即可,然後我們來安裝一些擴展:

中文語言配置

使用命令ctrl+shift+p調出搜索窗口進行配置,搜索Configure Language,然後安裝中文簡體語言包@category:"language packs",選擇中文簡體,重啓後即可生效。
在這裏插入圖片描述

MarkDown相關配置

通過擴展來安裝所有使用到的MarkDown語法需要使用的配置,安裝如下三個配置擴展:
在這裏插入圖片描述

這幾個擴展主要作用簡單介紹如下:

  • Markdown All in One:Markdown的基本語法全部包含進來。
  • Markdown Preview Enhanced:提供一些公式、PDF導出等功能
  • Markdown PDF:文件導出樣式提供多種方式,將MarkDown轉爲其它多種格式導出。
  • Markdown Shortcuts:提供一些一鍵生成MarkDown的方式,不過我不經常使用。

其實常使用的就是上邊三個。

GitBook相關配置

在擴展商店直接搜索gitbook,可以搜索到Gitbook kit,安裝該擴展後可以提供一些gitbook的常用操作。
在這裏插入圖片描述

然後我們用VSC打開該初始化的文件:
在這裏插入圖片描述

Calibre轉換工具配置

沒有這個工具使用命令gitbook pdf是沒有效果的,所以一定要安裝這樣一個軟件,安裝地址 【Calibre下載地址】,安裝完成後即可:
在這裏插入圖片描述
然後使用命令完成後即可正確生成該pdf:
在這裏插入圖片描述

結語

將本地book提交上去之後,可以使用VSC自帶的終端來處理,這樣就OK拉,大功告成啦,這就是國慶小作,拖延了很久的EBook使用指南。希望大家能從中受益嘍!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章