GitLab Pages 架設教學 - Gitbook

Gitbook,一個用來寫電子書的平台,在 V1 時非常好用,但近期改版為 V2 後,不但很多功能被拿掉,而且很多地方也改為付費制,V2 中還加入了 Space 機制,一本書就是一個 Space,免費使用者只能擁有一個公開 Space 和一個私人 Space,換言之就是使用者付費啦

可我還是很迷戀 V1,而且剛好我在 Gitbook V2 Beta 時開了兩個space,GitBook 提示我說:「欸你這樣不行」
就因為這兩個原因讓我爬著爬著發現 GitLab 官方文件裡面有提供架設 Gitbook 的範本,經過多方嘗試之後終於成功將V2的文章轉移過來啦!

準備

  • 註冊一個 GitLab 帳號
    這 不解釋
  • GitBook Editor (傳統板)
    用來編輯電子書,畢竟以前的 Gitbook 都是用這個工具編寫,而現在我們要架設的就是舊版的 Gitbook,所以用這套工具理所當然
  • GitHub Desktop
    用來與 GitLab 上的資料同步。 對,用 Github 來同步 GitLab。

第一步 - 偷過來

首先到 GitLab 官方提供的 Gitbook 範本偷(Fork)一份過來
gitbook_tutorial_1
GitLab 接著會提示請選擇命名空間,選自己的頭像就對了
gitbook_tutorial_2
緊接著進到自己剛剛 Fork 的專案中,於左側選擇 設定 > 一般,並展開 Advanced
gitbook_tutorial_3
然後選擇 Remove fork relationship,沒錯 我們要移除與主專案的連結,將這個專案變成自己的!
gitbook_tutorial_4
輸入 gitbook 解除連結
gitbook_tutorial_5
接著回到專案首頁,選擇 README.md,對他編輯並儲存,加個空白或者隨便打幾個字都可以,目的是要觸發 GitLab 產生頁面,完成後可以按左側的 CI/CD 確認是否已經開始建造
gitbook_tutorial_6
這時按 執行中(上圖) > pages 即可看到黑盒子
gitbook_tutorial_7
待黑盒子底部出現 Job succeeded 就代表成功啦!
gitbook_tutorial_8
成功後就前往 設定 > 頁面 領取我們的網頁連結吧!
gitbook_tutorial_9
好啦,到這邊為止我們已經做好 GitLab 上的初始設定了,接著讓我們開始本地端的操作吧!

第二步 - 從 GitLab 搶過來

打開你的 GitHub Desktop ,然後選擇 File > Clone Repository
gitbook_tutorial_10
接著從 GitLab 複製 Repo 的 git 網址,並貼到 GitHub Desktop 的 URL 頁面中
Local Path 請自行選擇一個合適存放的地點 (例如垃圾桶)
gitbook_tutorial_11
gitbook_tutorial_12

第三步 - 開始寫書

打開你的 GitBook Editor (這邊採用新版示範),起始畫面選擇 Do thet later
就算選了 Login 也登入不進去,GitBook 把舊版的登入權限拿掉了 (GitBook你到底在衝三小)
gitbook_tutorial_13

接著選擇 GitBook Editor > Open,並選擇到你剛剛儲存 Repo 的位置
gitbook_tutorial_14

然後就能看到書籍啦! 興奮吧?
gitbook_tutorial_15

第四步 - 還給 GitLab

GitBook Editor 這邊就不教學了,使用起來很簡單,總之完成後我們要把東西推上去 GitLab 讓他自動為我們產生電子書,這時候就是 GitHub Desktop 派上用場的時候啦!

打開你的 GitHub Desktop,並選到剛剛 Clone 下來的 Repo
1.Summary (required) 填入主要變更內容,Description 填入詳細變更內容(選填)
2.接著按下 Commit to master
3.最後一步,Push 上去 GitLab
gitbook_tutorial_15

接著就可到前面提到 GitLab 上的 CI/CD 查看是否開始自動產生囉!