GitBook 3.2.3入門


簡介
GitBook 是一個基於 Node.js 的命令行工具,可使用 GitHub / Git、Markdown、AsciiDoc來制作精美的電子書。GitBook 可以將文檔作為靜態網站或電子書(PDF,ePub或Mobi格式)輸出。
GitBook.com 是使用 GitBook 格式創建和托管圖書的在線平台,它提供托管,協作功能和易於使用的編輯器。
本文示例運行的系統為CentOS Linux release 7.4.1708,nodejs版本為v8.11.3。
 
安裝nodejs
訪問nodejs官網,下載nodejs,下載后的文件名為node-v8.11.3-linux-x64.tar.xz。
1.執行 tar -Jxvf node-v8.11.3-linux-x64.tar.xz,將nodejs解壓到當前目錄。
2.需要創建軟鏈接,執行 ln -s /usr/local/mine/node-v8.11.3-linux-x64/bin/node /usr/local/bin/node、ln -s /usr/local/mine/node-v8.11.3-linux-x64/bin/npm /usr/local/bin/npm。
 
安裝GitBook
1.執行 npm install gitbook-cli -g安裝GitBook命令行工具,自動選擇版本,同時也會安裝GitBook。
2.安裝完成后,可以在nodejs目錄里的bin目錄下看到gitbook軟連接文件,執行 ln -s /usr/local/mine/node-v8.11.3-linux-x64/bin/gitbook /usr/local/bin/gitbook,讓該命令全局可用。
npm命令的-g選項是指全局安裝,將模塊安裝到全局目錄中,全局目錄可以用npm config get prefix 命令獲取以及用npm config set prefix ""命令設置,不加-g則是將模塊下載到當前命令行所在目錄。
npm update gitbook-cli -g是更新命令,npm uninstall gitbook-cli -g是卸載命令。
 
GitBook命令
gitbook -h顯示GitBook 幫助信息,gitbook help顯示GitBook可用命令。
GitBook可以在本地安裝多個版本並在執行命令的時候指定某個版本,如果指定的版本還沒安裝就會自動下載安裝,下載后的GitBook會被放到~/.gitbook目錄下。相關操作有:
gitbook ls:列出本地已安裝的gitbook版本
gitbook current:列出當前活動的gitbook版本
gitbook ls-remote:列出遠程可以下載安裝的gitbook版本
gitbook fetch [version]:下載安裝某個gitbook版本
gitbook uninstall [version]:卸載某個gitbook版本
gitbook update:更新到最新的gitbook版本
如 gitbook -v 4.0.0-alpha.6 current會顯示GitBook version is 4.0.0-alpha.6,而gitbook -V會顯示gitbook和gitbook cli的運行版本。
 
初始化GitBook
1.執行 mkdir gitbook-demo && cd gitbook-demo 創建一個gitbook-demo目錄並進入到該目錄。
2.執行gitbook init 初始化GitBook,會在當前目錄下生成 README.md 和 SUMMARY.md文件。SUMMARY.md是GitBook的目錄文件。README.md是電子書介紹文件,必須存在。
也可以先手動創建SUMMARY.md,再執行gitbook init,如果SUMMARY.md中配置的文件夾和文件不存在,就會自動創建文件夾和文件,已經存在的文件夾和文件不會被覆蓋。一般情況下是先在gitbook-demo目錄下執行gitbook init,然后將要制作文檔的md文件放到gitbook-demo里,接着再修改SUMMARY.md。
gitbook init的更多用法參考gitbook help。
 
生成靜態網站
在gitbook-demo目錄下執行 gitbook build,會在gitbook-demo目錄下生成一個 _book 目錄,里面的內容為靜態網站的文件,可以將 _book 目錄下的文件拷貝到nginx、httpd等web服務器內,也可以使用gitbook serve命令啟動一個web服務,默認端口是4000。
gitbook build和gitbook serve的更多用法參考gitbook help。
 
GitBook目錄結構
基本結構如下:
├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1/
| ├── README.md
| └── something.md
└── chapter-2/
├── README.md
└── something.md
book.json:全局配置數據 (可選)
README.md:介紹電子書(必須)
SUMMARY.md:目錄 (可選)
GLOSSARY.md:詞匯、術語列表(可選)
 
SUMMARY.md格式
基本格式為:* [描述](文件路徑或者http超鏈接)。文件路徑是相對於SUMMARY.md所在的目錄的。
支持多級目錄,每級目錄多縮進4個空格。例如:
* [介紹](README.md)
* [概述](index.md)
* [接口](api.md)
* [注意事項](note.md)
 
GLOSSARY.md格式
基本格式是一組h2標題加上描述,在其他頁面用到這些詞匯時會突出顯示,鼠標放上去就會顯示術語描述。術語暫不支持中文。
例如:
## test
測試定義
 
book.json格式
GitBook 允許使用靈活的配置自定義電子書,這些選項在 book.json 文件中指定,格式為json。
root:包含除了 book.json外的所有電子書文件的根目錄。
structure:指定readme, summary, glossary和 languages的文件名,參考 Structure paragraph。
title:電子書名,默認值是從 README 中提取出來的。在 GitBook.com 上,這個字段是預填的。
description:書籍的描述,默認值是從 README 中提取出來的。在 GitBook.com 上,這個字段是預填的。
author:作者名。在GitBook.com上,這個字段是預填的。
isbn:國際標准書號 ISBN。
language:本書的語言類型 ,默認值是 en。
direction:文本閱讀順序,可以是 rtl (從右向左)或 ltr (從左向右),默認值依賴於 language 的值。
gitbook:應該使用的GitBook版本。使用 SemVer 規范,並接受類似於 “> = 3.0.0” 的條件。
 
Structure paragraph
除了 root 屬性之外,還可以指定readme, summary, glossary和 languages 的文件名,而不是使用默認名稱,如README.md。這些文件必須在項目的根目錄下,不接受的路徑。
structure.readme:readme 文件名(默認值是 README.md )
structure.summary:summary 文件名 (默認值是 SUMMARY.md)
structure.glossary:glossary 文件名(默認值是 GLOSSARY.md)
structure.languages:languages 文件名 (默認值是 LANGS.md)


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM