利用git作為版本管理和發布工具
你可以直接通過npm安裝gitbook到全局
npm
install
-g gitbook
gitbook只提供了如下四個命令
gitbook -h
Usage: gitbook
[options]
[
command
]
Commands
:
build
[options]
[source_dir]
編譯指定目錄，輸出Web格式(_book文件夾中)
serve
[options]
[source_dir]
監聽文件變化並編譯指定目錄，同時會創建一個服務器用於
預覽
Web
pdf
[options]
[source_dir]
編譯指定目錄，輸出PDF
epub
[options]
[source_dir]
編譯指定目錄，輸出epub
mobi
[options]
[source_dir]
編譯指定目錄，輸出mobi
init
[source_dir]
通過
SUMMARY
.md生成作品
目錄
源文件目錄一般是這樣的.
- LANGS.md
當你需要發布多個語言版本時，根目錄只需要放置一個LANGS.md, 格式如下
* [English](en)
* [中文](zh)
* ...
每個zh，en文件夾現在就相當於一個獨立的書籍.
- README.md 相當於書籍的前言部分, 可以忽略
cover_small.png 和 cover.png書籍的封面圖
SUMMARY.md
SUMMARY是
最重要的一個部分
, 它創建的是整書的
索引,
可以通過
gitbook init
讀取
SUMMARY.md
來
生成目錄結構，
格式如下
注意：*和-都是無序列表符號
* [前言](
introduct
/README.md)
- [API索引](
introduct
/index.md)
* [高級特性](
advanced
/README.md)
- [內嵌組件](
advanced
/component.md)
- [regular的transclude](
advanced
/content.md)
- [小節](
advanced
/review.md)
接下來就是依次完成你每個章節的書寫了, 你需要開啟
gitbook serve .
來進行實時的web預覽(服務器默認為
localhost:400
)
現在的程序圈的markdown包括gitbook普遍使用的是
GitHub Flavored Markdown
，除了github中已經說明的那些, 它還支持一些額外的小特性, 比如
[x]
可以用來設置一個checkbox來實現todolist的功能.
發布
可以直接使用
git
發布，首先你需要添加gitbook的倉庫作為你的一個遠程庫. 比如regularjs的路徑為
git remote
add
gitbook
https://push.gitbook.io/leeluolee/regular-guide.git
git
push
gitbook master
可以發布到我的個人網站嗎?
當然可以，
gitbook build
之后的
_book
就是一個完整的web目錄, 你可以放置到你的個人網站上.
一個更好的做法是直接發布到github的
gh-pages
上, 由於gitbook每次build都會重新生成整個目錄.所以你需要利用
gulp-gh-pages
或
grunt-gh-pages
等工具進行發布.
最簡單的方式就是使用GitBook編輯器
電子書出版：
同步GitHub
git
config
--
global
gitbook
.
user
username
git
config
--
global
gitbook
.
token
yourtoken
安裝 nodejs
首先我們需要做的是安裝
Nodejs
。大家可以到
Nodejs
的官網進行下載。下載完成后，執行雙擊進行運行安裝。安裝完成后，打開 cmd 命令行，輸入 node -v 查看安裝的 nodejs 的相關版本信息。
nodejs 安裝完成后，我們就可以開始安裝 gitbook 了。但是在安裝之前，我們還需要配置一下 nodejs 插件安裝的下載鏡像地址。因為默認的鏡像地址是在國外，需要翻牆才可以訪問，因此我們需要設置國內的鏡像地址。國內的我推薦大家使用阿里巴巴的鏡像地址
http://registry.npm.taobao.org
。執行下面的命令，進行配置。
全局安裝 gitbook
現在我們可以開始安裝全局的 gitbook 了。執行 npm install gitbook-cli -g 命令，進行安裝。安裝的過程中，由於需要下載安裝包，因此大家需要等待一定的時間，具體時長取決於你的網速和硬件配置。
安裝完成后，我們可以執行 gitbook -v 查看安裝的版本信息。
最常用的命令
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
//輸出錯誤信息
常用插件
內容頂部顯示
編輯本頁
鏈接。
在右上角顯示 github 倉庫的圖標鏈接。
添加 disqus 評論插件。
顯示 github 倉庫的 star 和 fork 按鈕。
用法非常簡單，基本上就只有兩步：
- 使用 gitbook init 初始化書籍目錄
- 使用 gitbook serve 編譯書籍
首先，創建如下目錄結構：
README.md 和 SUMMARY.md 是兩個必須文件，README.md 是對書籍的簡單介紹：
$ cat book/README.md
# README
This is a book powered by [GitBook](
https://github.com/GitbookIO/gitbook).
SUMMARY.md 是書籍的目錄結構。內容如下：
$ cat book/SUMMARY.md
# SUMMARY
* [Chapter1](chapter1/README.md) * [Section1.
1
](chapter1/section1.
1
.md) * [Section1.
2
](chapter1/section1.
2
.md) * [Chapter2](chapter2/README.md)
創建了這兩個文件后，使用
gitbook init
，它會為我們創建 SUMMARY.md 中的目錄結構。
GitBook使用
在線編輯：
進入到書籍的屬性頁面后，點擊 "Edit Book" 按鈕即可打開在線編輯器。
另一種方式，是直接使用文本編輯器，編寫 Markdown 文檔，然后，使用 Git 提交到書籍的遠程項目，當然，提交前，最好在本地使用
gitbook
預覽效果；提交后，GitBook.com 會自動生成更新書籍的內容。
