gitbook的安裝與使用
gitbook的安裝與使用
一、安裝gitbook
1.1、基礎條件
查看是否安裝了nodejs
# node -v
v10.22.0
# npm -v
6.14.6
1.2、安裝gitbook
使用npm安裝 gitbook
# sudo npm install -g gitbook-cli
二、使用gitbook
2.1、創建書籍
在指定的目錄中，通過gitbook官方模板創建書籍
# cd /opt/blog
# gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished
- README.md 是介紹頁。
- SUMMARY.md 是目錄頁。
2.1.1、一般目錄結構
├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1
├ ├── README.md
├ ├── something.md
├── chapter
├ ├── README.md
├ ├── something.md
| 文件名 | 描述 |
|---|---|
| book.json | 配置數據（可選） |
| README.md | 電子書的前言或簡介（必須） |
| SUMMARY.md | 電子書目錄 （可選） |
| GLOSSARY.md | 詞匯/注釋術語列表（可選） |
可以自己靈活制定自己的目錄結構。
2.1.1、book.json的配置說明
| 變量 | 描述 |
|---|---|
| root | 包含所有圖書文件的根文件夾的路徑，除了 book.json |
| structure | 指定自述文件，摘要，詞匯表等的路徑 |
| title | 您的書名，默認值是從 README 中提取出來的。在 GitBook.com 上，這個字段是預填的。 |
| description | 您的書籍的描述，默認值是從 README 中提取出來的。在 GitBook.com 上，這個字段是預填的。 |
| author | 作者名。在GitBook.com上，這個字段是預填的。 |
| isbn | 國際標準書號 ISBN |
| language | 本書的語言類型 —— ISO code 。默認值是 en |
| direction | 文本閱讀順序。可以是 rtl （從右向左）或 ltr （從左向右），默認值依賴于 language 的值。 |
| gitbook | 應該使用的GitBook版本，并接受類似于 >=3.0.0 的條件。 |
| links | 在左側導航欄添加鏈接信息 |
| plugins | 要加載的插件列表(官網插件列表) |
| pluginsConfig | 插件的配置 |
2.2、預覽書籍
在gitbook書籍目錄中執行如下命令，便可在本地通過訪問http://localhost:4000 進行書籍預覽
# gitbook serve
2.3、同時部署多個gitbook服務
gitbook啟動的web 服務默認監聽4000端口，而重啟監控進程默認監聽35729端口。
在不改變端口的前提下，一般只可以啟動一個電子書web服務。
啟動當前gitbook目錄
gitbook serve
啟動/somepath/your_docuemtn_dir/下的gitbook目錄
gitbook serve /somepath/your_docuemtn_dir/
啟動完成后本地就可以通過 http://localhost:4000 進行訪問。
如果需要啟動多個web服務的話，需要同時修改web端口和監控進程端口：
gitbook serve --lrport 18081 --port 8081 /otherpath/your_docuemtn_dir/
2.4、生產電子書
--- 生成PDF文件
# gitbook pdf ./ ./mybook.pdf
--- 生成ePub文件
# gitbook epub ./ ./mybook.epub
--- 生成Mobi文件
# gitbook mobi ./ ./mybook.mobi
三、插件
3.1、Gitbook 默認帶有 5 個插件：
highlight - 語法高亮插件、search - 搜索插件、sharing - 分享插件、font-settings - 字體設置插件、livereload - 熱加載插件
3.2、去除自帶插件
可以在插件名稱前面加 -
"plugins": [
"-search"
]
Tips：添加插件后要進行安裝 gitbook install
gitbook常用CMD
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 //輸出錯誤信息
| 222 | 22 | |
|---|---|---|
| 22 | 222 |
浙公網安備 33010602011771號