Gitbook架設 Part 1

根據目前查到的資料,似乎線上版有一些微微妙妙的問題, 所以這邊打算採用自己架設的做法。

因為文件都散落在各個MD檔之中,想說要找找一個方便地管理工具 有很多東西因為以前比較少碰到,所以也算是粗略做個記錄。

以下是踩坑過程。

安裝yarn

要安裝Gitbook的時候,網路上搜尋到的是用npm來安裝。 然後莫名的就搜尋到新的管理工具yarn

秉持著有新的就用新的原則,就學著用新的工具來安裝看看。

brew install yarn

然後就是安裝gitbook套件

yarn global add gitbook gitbook-cli

因為有很多地方都打算導入gitbook來管理文件,所以就選用global

node 與 nvm

然後按照教學輸入

gitbook init

之後就就很順利地炸了。error log如下

warn: no summary file in this book
info: create SUMMARY.md

TypeError [ERR_INVALID_ARG_TYPE]: The "data" argument must be of type string or an instance of Buffer, 
TypedArray, or DataView. Received an instance of Promise

發現是node的版本太新,可以用node -v來檢查當前的node版本。

於是就開始研究nvm的使用方式。

nvm: 管理Node版本的工具

使用homebrew來安裝nvm

brew install nvm

安裝成功後有一些環境變數要設定到.zshrc(或是.bashrc中) 全部處理完成以後就可以使用nvm來管理node

nvm ls-remote
nvm install v13.14.0
nvm use v13.14.0

詳細的nvm指令與功能就另外開一篇來寫好了,就不在這邊多說了。

切換node版本以後就可以順利執行了

再次輸入:

gitbook init

會產生一個SUMMARY.md檔,這是左側的目錄

裡面也是使用markdown的超連結方式進行撰寫

路徑的部分還沒想好應該要怎麼部,就先做個測試版吧。

# Summary

* [Introduction](README.md)
* [Test1](test1/test1.md)
* [Test2](test2/test2.md)
    * [Sub2](test2/test2-2.md)

第一部分就先寫個架設篇, 後面真的用起來了再來寫第二部分。

Reference