一、是什么
明確一點Git 與 GitBook 就像雷鋒和雷峰塔完全沒有一點關系。
實際上,GitBook 是 一 個 基 於 Node.js 的 命 令 行 工 具 , 支 持 Markdown 和 AsciiDoc 兩種語法格式,可以輸出 HTML、PDF、eBook等格式的電 子書。所以我更喜歡把 GitBook 定義為文檔格式轉換工具。目前使用的搭配是 GitBook + Typora + Git。
二、如何搭建 GitBook 環境?
因為GitBook 是基於 Node.js,所以我們首先需要安裝 Node.js
1、安裝 Node.js
下載地址:https://nodejs.org/en/download/
LTS 版本是一個支持 NodeJS 老版本特性的特殊新版本,Current 版本屬於
一個全新的新版本。如果你的NodeJS 應用使用的比較老的 SDK 開發,LTS 版
本能讓你平滑升級到新版本。
如果你的NdoeJS 應用使用的是全新的 SDK 開發選擇 Current 版本即可。
2、windows 安裝
安裝結束之后使用cmd 控制台輸入node -v 出現版本號則成功、
如果命令無法找到。則需要配置環境變量。
1、配置環境變量
將node.js 的路徑加入環境變量,重啟控制台重新輸出 node -v 即可
4、mac 安裝
1、雙擊安裝程序安裝
如下:
2、顯示程序將會安裝的位置
一直點擊繼續到最后為
3、在終端中輸入命令
node –v
npm –v
如下:
若展示如上說明node 安裝成功
4、若 node-v 提示為失敗
- bash: node: command not found
需要配置環境變量了步驟如下
進入,finder 右鍵選擇”前往文件夾”如下
進入etc
文件夾中找到“profile”文件,此文件鎖定可以復制一份出來加上以下語句:
export NODE_HOME=" node 安裝路徑(bin 路徑的父級路徑)"
export PATH=$PATH:$NODE_HOME/bin
步驟2 中已有 node 安裝路徑為/usr/local/bin/node所以我自己這邊增加語句如下:
export NODE_HOME="/usr/local" export
PATH=$PATH:$NODE_HOME/bin
ps:( 如果不記得 node 的安裝路徑,可以打開終端,輸入 which node即可找出node 安裝路徑 )
改完profile 副本文件保存為不帶后綴的文件,名字亦為profile 即可覆蓋原來的 profile,環境變量配置好了就可以按照步驟 3 來驗證了。
2、安裝 gitBook
打開命令行,執行npm install -g gitbook-cli
Gitbook-cli 不能有空格
安裝完成
檢驗:
Gitbook -v
無錯誤即可
三、GitBook 如何使用
1、配置
1、創建一個文件夾名為 mybook(名字可以隨便取)
2、在控制台上找到這個文件夾並輸入gitbook init
安裝成功之后,目錄下會出現兩個文件。
3、將此文件夾拖拽到 VSCode 中就可以進行吧編輯
SUMMARY.md 為目錄超鏈接文檔,語法格式為:markdown 格式。
小括號內為超鏈接
4、點擊此按鈕為預覽
5、編輯成功之后再 cmd 中運行 gitbook serve
瀏覽器訪問如上地址
6、如果遇到如下問題
請關閉殺毒軟件別問我為什么
運行成功之后為
7、如果要寫文檔則需要新建一個 .md 文檔將其路徑添加到對應的
SUMMARY.md 的超鏈接中
2、未完待續
....