天天看點

GitBook使用心得

GitBook使用心得

前言

最近想系統性的寫些東西,但愁沒有合适的編輯工具,直到認識了gitbook這個工具,使用gitbook工具寫文檔格式清晰且很容易對文檔進行規範性編寫,是以可以提高編輯效率。下面是我把在使用過程中的一些關鍵流程、使用方法和遇到的問題寫下來供大家參考。

部署環境

1、安裝Nodejs

這裡采用nodejs二進制檔案方式安裝,不需要編譯直接解壓即可使用。

# 建立nodejs目錄
mkdir -p /usl/local/nodejs && cd $

# 從官方網站下載下傳二進制壓縮包
wget https://nodejs.org/dist/v8.9.0/node-v8.9.0-linux-x64.tar.xz
    
# 解壓部署
tar -xvf node-v8.9.0-linux-x64.tar.xz

# 配置環境變量
編輯/etc/profile檔案在最後面加上這兩句:
export NODE=/usl/local/nodejs/node-v8.9.0-linux-x64
export PATH=$PATH:$NODOE/bin

接着執行:source /etc/profile,是配置環境生效

# 檢視版本資訊
node -v
npm -v
           

如果上面nodejs安裝成功的話,檢視版本資訊會有如下效果:

GitBook使用心得

2、安裝GitBook指令行工具

# 需要先安裝gitbook然後安裝gitbook-cli才能使用指令行
npm install gitbook -g

# 安裝指令行工具
npm install gitbook-cli

# 檢視gitbook版本,注意:  V 是要大寫的,小寫不生效
gitbook -V
           

如果上面gitbook安裝成功的話,檢視版本資訊會有如下效果:

GitBook使用心得

3、安裝Typora編輯器

# 官網下載下傳&安裝,下載下傳下來的是exe檔案,直接執行安裝即可
https://www.typora.io/
           

####編寫文檔

1、認識Markdown文法

對于Markdown文法不熟悉的可以學習Markdown入門參考

2、啟動gitbook文檔服務

編寫完文檔後需要在浏覽器上面看效果,是以需要啟動一個文檔服務。

# 開啟端口,後面一個.表示的是目前檔案夾,可以在文檔根目錄也可以另外指定目錄
gitbook serve -p 8080 .
           

小結

到此,關于GitBook的一些使用方法已經寫完。總體來說這個工具的使用還是比較簡單的,隻需要懂得指令行和markdown文法即可。前期部署環境工作相對麻煩一點,隻要懂得markdown文法寫出來的文檔排版都會比較清晰&整齊,無需另外再糾結于文檔的排版,可回歸專注于寫作内容。

參考

Centos之GitBook文檔工具安裝與使用-yellowcong

繼續閱讀