gitbook 入門教程之環境要求

雪之夢技術驛站發表於2019-04-01
Git

gitbook 是基於 node.js 的命令列工具,首先需要安裝並配置好 node.js 環境,然後才能安裝gitbook 相關工具.

由於安裝工具全部都是國外網站,因此速度可能會很慢,也可能需要FQ,請耐心等待或者學會科學上網.

當然如果安裝過程中遇到任何問題,也可以找我要一下安裝包或者我幫你免費解決下.

環境預檢查

檢查 git 環境[可選]

git 是免費開源的分散式版本控制系統,主要用於電子書的更新管理和團隊協作,如果不需要將電子書託管到github 網站上,則可以不安裝 git .

如果列印出 git 版本資訊,則表示本機已安裝 git 環境,跳過此步驟.

$ git --version
複製程式碼

git 安裝配置教程請參考初識 git

檢查 node.js 環境[必須]

node.js 是 js 在服務端執行的環境基礎,從而使得 js 從瀏覽器端延伸到服務端領域,而 gitbook 則是執行在 node.js 基礎之上的命令列工具,因此必須先安裝好 node.js 開發環境.

如果列印出 node.js 版本資訊,則表示本機已安裝 node.js 環境,跳過此步驟.

$ node -v
複製程式碼

node.js 安裝配置教程請參考 nodejs.org/

檢查 gitbook 環境[必須]

gitbook-cli 是 gitbook 的腳手架工具,幫助我們更方便構建 gitbook 應用,當然也可以直接安裝 gitbook ,只不過那樣的話,略顯麻煩,不推薦.

如果列印出 gitbook 和 cli 版本資訊,則表示本機已安裝 gitbook 環境,跳過此步驟.

$ gitbook -V
複製程式碼

否則的話,本機可能並沒有安裝 gitbook 環境,則需要安裝 gitbook 相關工具.

因為 gitbook 是基於 node.js 環境,而安裝好 node.js 後預設提供了 npm 包管理工具,而我們則是通過 npm 來安裝其他工具.

安裝 gitbook-cli 工具[必須]

假設你已經搭建好 node.js 環境,現在我們開始安裝 gitbook 相關工具了!

$ sudo npm install -g gitbook-cli
複製程式碼

全域性安裝的話,可能需要超級管理員許可權,輸入下相應密碼即可繼續安裝,如無報錯,則表示安裝成功.

安裝成功後會帶有 gitbook 命令,現在再次執行下 gitbook -V 檢視版本資訊.

# 列印出 `CLI` 和 `GitBook` 版本資訊即可,安裝版本可能已經大於 `2.3.2`
$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3
$ 
複製程式碼

安裝 GitBook Editor 編輯器[可選]

gitbook 官方客戶端編輯器,支援 windows, mac 和 linux ,主要用於視覺化編輯文件,組織文件結構.

下載相應平臺的 GitBook Editor,正常安裝即可.

gitbook-editor-preview.png

gitbook 的使用方法大致可以有三種,而 GitBook Editor 編輯器只是其中一種,所以這一步是可選的.

  • 使用 gitbook-cli 腳手架提供的各種命令直接在命令列管理 gitbook,適合一定程式設計經驗的軟體從業人員.
  • 使用 GitBook Editor 編輯器管理 gitbook ,適合無任何程式設計的文學創作者.
  • 使用 gitbook.com 官網線上管理 gitbook ,適合不具備本地開發環境的萌新體驗者.

小結

gitbook 基於 node.js 開發環境,因此首先要安裝好 nodejs 環境,其次再使用 node.js 提供的 npm 包管理工具來安裝 gitbook.

只需執行 sudo npm install -g gitbook-cli 即可安裝,接著執行 gitbook -V 檢視安裝版本資訊確認已經安裝成功.

至此 gitbook 的必要開發環境已經準備妥當,接下來讓我們趕緊體驗一下 gitbook 的魅力吧!

相關文章