gitbook 入門教程之導出電子書

gitbook 既可以將源碼文件單獨輸出,也可以僅輸出單個文件,常見的導出電子書格式主要有三種(ePub, Mobi, PDF),而這三種格式都依賴於系統本身提供的 ebook-convert 工具.

安裝依賴

如果直接運行 gitbook pdf 相關命令,可能會報錯,提示需要安裝 ebook-convert 插件,根據提示本地需要安裝 calibre 軟件,這樣 gitbook 才能正常導出電子書.

calibre 官網: https://calibre-ebook.com/

linux 系統

下載地址: https://calibre-ebook.com/download_linux

• 下載應用

$ sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.sh | sudo sh /dev/stdin

• 配置軟鏈接

$ sudo ln -s /usr/bin/nodejs /usr/bin/node

mac 系統

下載地址: https://calibre-ebook.com/download_osx

• 下載應用

將 calibre.app 移動到應用程序文件,然后嘗試是否能正常打開應用.

• 配置軟鏈接

$ sudo ln -s ~/Applications/calibre.app/Contents/MacOS/ebook-convert /usr/bin

• 測試命令

$ ebook-convert --version

如果沒有輸出 ebook-convert 版本信息,可能需要配置環境變量.

配置封面

所有格式的電子書都可以配置自定義封面,在項目的根目錄下提供 cover.jpg 和 cover_small.jpg 兩種封面圖片時,生成電子書會自動增加封面頁.

當然你也可以使用 autocover 插件 自動生成封面,不過本人才疏學淺,幾經嘗試始終沒有成功,如果有人成功了記得給我留言下哈!

封面的基本要求:

• cover.jpg 尺寸大小: 1800X2360 px,cover_small.jpg 尺寸大小: 200x262 px;
• 無邊界
• 清晰可見的書名
• 任何重要的文字在小版本封面圖片中也要清晰可見

更多封面相關規范請參考 https://toolchain.gitbook.com/ebook.html

基本命令

語法格式: gitbook pdf 或 gitbook epub 或 gitbook mobi

示例:

# 生成 `pdf` 文件並輸出 `debug` 級別日志
$ gitbook pdf ./ ./myBook.pdf --log=debug

# 生成 `epub` 文件並輸出 `debug` 級別日志
$ gitbook epub ./ ./myBook.epub --log=debug

# 生成 `mobi` 文件並輸出 `debug` 級別日志
$ gitbook mobi ./ ./myBook.mobi --log=debug

相信大家對 PDF 格式比較熟悉,其余兩種格式只是不同電子書格式,因而需要相應軟件支持.

生成 PDF 文件

示例:

$ gitbook pdf

默認在當前項目的根目錄下生成 book.pdf 文件名,如果配有封面,則首頁顯示封面,否則無封面.

生成 ePub 文件

示例:

$ gitbook epub

默認在當前項目的根目錄下生成 book.epub 文件名,如果配有封面,則首頁顯示封面,否則無封面.

生成 mobi 文件

示例:

$ gitbook mobi

默認在當前項目的根目錄下生成 book.mobi 文件名,如果配有封面,則首頁顯示封面,否則無封面.

小結

本節主要介紹了如何導出電子書,概括來說,首先系統需要安裝 ebook-convert 工具,然后配置電子書封面,最后直接導出為目標格式(ePub, Mobi, PDF)進行輸出.

隨着電子書內容越來越多,生成電子書所花費的時間也越來越久,實屬正常,耐心等待即可.

輸出 PDF 文件並輸出 debug 日志: gitbook pdf --log=debug