使用GitBook編寫文件書籍

gitbook 是乙個基於 node.js 的命令列工具，可使用 github/git 和 markdown 來製作精美的電子書。gitbook支援輸出以下幾種文件格式：

gitbook可以用來寫書、api文件、公共文件，企業手冊，**，研究報告等。

npm config set registry .taobao .org

1、nmp安裝gitbook

npm install gitbook -g //安裝命令 npm install -g gitbook-cli //解除安裝命令 npm uninstall -g gitbook

2、檢驗下是否安裝成功

//顯示gitbook以及gitbook-cli版本號 gitbook -v

readme.md是關於你的書的介紹，而summary.md中則包含了書的目錄。我們還可以新增「book.json（電子書配置檔案）」、「glossary.md（書尾詞彙表）」以及「封面」等，預設檔案樹中沒有這些，需要自行新增。

1. 生成圖書目錄結構

建立乙個目錄test，使用gitbook init命令就可以在目錄下生產這兩個檔案。乙個summary.md檔案的格式大致如下，每一行對應乙個相應的檔案。

# summary
* [introduction](readme.md)
* [第一章](chapter1/readme.md)
* [第一節](chapter1/seciont1.md)
* [第二節](chapter1/section2.md)
* [第二章](chapter2/readme.md)
* [第一節](chapter2/seciont1.md)
* [第二節](chapter2/section2.md)
* [結束](end/readme.md)

執行 gitbook init 會根據 summary.md 目錄生成對應的資料夾和 md 檔案，每乙個 md 檔案對應每一章節，每一章節的內容在對應的 md 檔案裡編輯，你可以使用本地支援markdown語法的編輯器編輯，例如markdown pad。

如果想要新增章節，可以在 summary.md 裡面新增，然後執行 gitbook init 就會新增對應的 md 檔案，原有檔案不會變化；如果想要刪除章節，在 summary.md 裡面刪除，然後執行 gitbook init 想要刪除的 md 檔案並不會刪除，需要手動刪除。

2. 生成圖書

2.1 輸出為靜態**

執行下面的命令

$ gitbook serve

然後瀏覽器中輸入 http://localhost:4000 就可以預覽生成的以網頁形式組織的書籍。

這裡你會發現，你在你的圖書專案的目錄中多了乙個名為_book的檔案目錄，而這個目錄中的檔案，即是生成的靜態**內容。

使用build引數生成到指定目錄

$ mkdir /tmp/gitbook $ gitbook build --output=/tmp/gitbook

2.2 輸出為pdf

輸出為pdf檔案，需要先使用npm安裝上gitbook pdf：

$ sudo npm install gitbook-pdf

-g

新建book.json，可以做一些配置，比如標題，作者，指定readme檔案，關閉分享鏈結等。

,
"links": 
},"plugins": ["disqus","advanced-emoji"],
"pluginsconfig": 
}}

# 安裝外掛程式 $ gitbook install ./

gitbook命令

gitbook init //初始化目錄檔案 gitbook help //列出gitbook所有的命令 gitbook --help //輸出gitbook-cli的幫助資訊 gitbook build //生成靜態網頁 gitbook serve //生成靜態網頁並執行伺服器 gitbook build --gitbook=2.0 .1gitbook 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 //輸出錯誤資訊

1、註冊 gitbook.com 賬號

首先進入 gitbook.com 註冊乙個賬號，並新建乙個專案。在「setting（設定）」頁面獲取到「git url（git 鏈結）」，如下所示：

2、使用git上傳電子書專案

在本地新建乙個資料夾，並通過 git 命令把剛才新建的遠端專案抓取到本地，如下所示：

然後把本地電子書專案「test」中的所有內容拷貝到剛才新建的資料夾中，如上面的「firstbook」。然後使用 git 命令把本地的專案上傳到遠端，如下所示：

git add -a git commit -m "提交說明"

git push 命令中的 -u 表示將本地 master 分支的上游分支設定為 github/master，下次直接使用git push命令即可。

更多教程參看這裡。

使用GitBook編寫文件書籍

使用GitBook編寫專案文件

如何使用gitbook建立文件web頁面

使用Sphinx編寫文件

使用GitBook編寫文件書籍

使用GitBook編寫專案文件

如何使用gitbook建立文件web頁面

使用Sphinx編寫文件

相關推薦