2021-05-12 14:32:11
Gitbook簡易使用教學
簡介
GitBook 是一個基於 Node.js 的命令列工具,可使用 Github/Git 和 Markdown 來製作精美的電子書。GitBook支援輸出以下幾種文件格式
靜態站點:GitBook預設輸出該種格式
PDF:需要安裝gitbook-pdf依賴
eBook:需要安裝ebook-convert
準備安裝
在使用GitBook 之前, 我們需要先安裝一些必須的工具,Node.js、GitBook、GitBook Editor、Git版本控制器。
Node.js
Node.js 是一個基於Chrome JavaScript 執行時建立的一個平台, 用來方便地搭建快速的, 易於擴充套件的網路應用· Node.js 借助事件驅動, 非阻塞 I/O 模型變得輕量和高效, 非常適合 run across distributed devices 的 data-intensive 的實時應用。
1、win下安裝Node.js
直接到nodejs官網下載,簡單安裝即可,此處不再細述。
2、檢測是否安裝成功
node -v //顯示v4.1.1
GitBook
GitBook 是一個基於 Node.js 的命令列工具,可使用 Github/Git 和 Markdown 來製作精美的電子書。通過Node.js命令安裝GitBook
1、NMP安裝Gitbook
npm install gitbook -g
2、安裝gitbook CLI
想在系統上的任何地方的gitbook命令,需要安裝“gitbook CLI”,執行以下命令
//安裝命令
npm install -g gitbook-cli
//解除安裝命令
npm uninstall -g gitbook
3、檢驗下是否安裝成功
gitbook -V //顯示0.4.2
Git
Git是一款免費、開源的分散式版本控制系統,用於敏捷高效地處理任何或小或大的專案。基本安裝請點選安裝教學。如果不需要從GitHub更新書到本地再編譯,則可以不安裝Git。
GitBookEditor
GitBook官方用戶端編輯器,支援Win、Linux、Mac系統。請點選下載GitBookEditor。使用該編輯器可以快速的建立、編輯GitBook。安裝具有以下步驟:
解壓下載包 gitbook-editor-4.2.1-windows-ia32.zip
執行GitBook Editor Setup.exe進行預設安裝
基本使用
GitBook 大致分為兩種使用方式,即離線和線上。最簡單的使用方式是使用GitBook Editor編輯GitBook ,然後使用相關命令編譯成功HTML。當然還有以下幾種方式
使用命令建立基本GitBook
使用網頁線上編輯器建立、編輯GitBook。
使用itBookEditor用戶端建立、編輯GitBook。
gitBookEditor
使用用戶端方式,支援線上和本地兩種方式建立、編輯GitBook,再執行相關命令編譯成HTML,這種方式比較方便,推薦使用。以本地建立書籍為例
1、gitBookEditor用戶端基本使用
2、使用命令對已經建立的Book進行編譯
找到需要編譯的書籍所在目錄,執行gitbook serve 命令,在本電腦的預設路徑為C:UsersQGYGitBookLibraryImportgitbooksimpletutorial,如圖所示
高階擴充套件
掌握了“基本使用”,但有時候想要gitBook更美觀,或者更符合我們自己的需求,則通過book.json設定進行自定義、以及安裝一些常用的外掛等。
Book.json設定
GitBook 在編譯書籍的時候會讀取書籍原始碼頂層目錄中的 book.js 或者 book.json,這裡以 book.json 為例,參考 GitBook 文件 可以知道,book.json 支援如下設定
{
//樣式風格設定格式
"styles": {
"website": "styles/website.css",
"ebook": "styles/ebook.css",
"pdf": "styles/pdf.css",
"mobi": "styles/mobi.css",
"epub": "styles/epub.css"
},
//外掛安裝設定格式
"plugins": ["myplugin"],
"pluginsConfig": {
"myPlugin": {
"message": "Hello World"
}
}
}
自定義外掛擴充套件
外掛是擴充套件GitBook功能最好的方法。使得GitBook功能更加強大,例如,把數學公式顯示支援,跟蹤回訪使用谷歌解析,…以toggle-chapters外掛為例
toggle-chapters 外掛的效果是預設只在目錄導航中顯示章的標題,而不會顯示小節的標題,點選每一章或者每一節會顯示當前章或節的子目錄,如果有的話,但是同時會收起其它之前展開的章節。所以,個人認為不是非常實用,因為這樣子使用者不能快速跳轉到沒有展開的章節!
一、搜尋、安裝外掛方式
1、編輯器方式(沒成功)
2、通過GitHub方式
www.plugins.gitbook.com
3、node.js命令方式
-
預設安裝在以下路徑
C:UsersQGYAppDataRoamingnpmnode_modules
-
把外掛資料夾複製到
npm install gitbook-plugin-toggle-chapters --save-dev
二、通過Book.json設定外掛
"plugins": ["toggle-chapters"],
"pluginsConfig": {
"myPlugin": {
"message": "Hello World"
}
}
本文永久更新連結地址:http://www.linuxidc.com/Linux/2017-05/144344.htm
相關文章