GitBook 入門學習

1、什麼是 Gitbook

GitBook 是一個基於 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 兩種語法格式,能夠輸出 HTML、PDF、eBook 等格式的電子書。javascript

Gitbook 使用方案:html

  • GitBook + Typora / Vscode+ Git:推薦
  • GitBook + Gitbook Editor+ Git

Git 須要依賴 Node.js,Node.js 和 Git 安裝都很簡單,這裏就再也不贅述,相關連接以下:java

2、Gitbook 安裝及使用

安裝命令:node

# 打開命令行(管理員)執行如下命令,安裝 Node.js 時已經安裝好 npm 工具包
npm install -g gitbook-cli

安裝好以後,會多了一個 gitbook 命令,如今來初始化一本書:python

cd E:
mkdir mybook
cd mybook
gitbook init        # 初始化

執行完畢會發現 mybook 目錄中多了兩個文件:git

  • README.md:書籍介紹
  • SUMMARY.md:書籍目錄結構

用 Typora 打開 SUMMARY.md,編輯以下(此步是編寫書籍目錄):web

# 目錄

* [前言](README.md)
* [第一章](Chapter1/README.md)
  * [第1節:衣](Chapter1/衣.md)
  * [第2節:食](Chapter1/食.md)
  * [第3節:住](Chapter1/住.md)
  * [第4節:行](Chapter1/行.md)
* [第二章](Chapter2/README.md)
* [第三章](Chapter3/README.md)
* [第四章](Chapter4/README.md)

再執行 gitbook init,gitbook 就會自動建立相應章節,以下圖所示:npm

還能夠生成 HTML 靜態文件,在瀏覽器中查看:json

gitbook serve

出現錯誤:瀏覽器

解決:找到 C:\Users\hj\.gitbook\versions\3.2.3\lib\output\website\copyPluginAssets.js 文件,註釋掉第 112 行:

return fs.copyDir(
        assetsFolder,
        assetOutputFolder,
        {
            deleteFirst: false,
            overwrite: true,
            /*confirm: true*/           /*註釋這行*/
        }
    );

參考文章:http://www.javashuo.com/article/p-twpsokwy-dh.html

再次執行 gitbook serve

訪問:<http://localhost:4000/

3、經常使用命令

# 構建書籍,默認將生成的靜態網站輸出到 _book 目錄
gitbook build

# 指定路徑
gitbook build [書籍路徑] [輸出路徑]

# 指定端口
gitbook serve --port 2333

# 你還能夠生成 PDF 格式的電子書
gitbook pdf ./ ./mybook.pdf
gitbook epub ./ ./mybook.epub       # epub 格式
gitbook mobi ./ ./mybook.mobi       # mobi 格式

其餘命令:

gitbook init         //初始化目錄文件
gitbook help         //列出gitbook全部的命令
gitbook --help      //輸出gitbook-cli的幫助信息
gitbook build        //生成靜態網頁
gitbook serve       //生成靜態網頁並運行服務器
gitbook build --gitbook=2.0.1        //生成時指定gitbook的版本, 本地沒有會先下載
gitbook ls                          //列出本地全部的gitbook版本
gitbook ls-remote                   //列出遠程可用的gitbook版本
gitbook fetch 標籤/版本號            //安裝對應的gitbook版本
gitbook update                  //更新到gitbook的最新版本
gitbook uninstall 2.0.1             //卸載對應的gitbook版本
gitbook build --log=debug            //指定log的級別
gitbook builid --debug                  //輸出錯誤信息

參考文章

相關文章
相關標籤/搜索