我的Wiki搭建(Gitbook + GitHub Pages)

工具選擇:Gitbook + GitHub Pages

大概流程:

首先在本地編寫md文件,而後生成對應的html文件,最後將這些html文件推送到github對應的gitbook倉庫。html

具體步驟:

(一)本地gitbook安裝與初始化git

  1. 在本地安裝 gitbook工具,詳細步驟網上不少,不贅述!github

  2. 在本地建立一個目錄,切換至該目錄,執行gitbook init初始化;
    而後,執行gitbook serve能夠經過訪問 來預覽效果。 工具

  3. 一樣在該目錄內,執行命令gitbook build,它會將相應的md文件轉爲相應的html文件,就在 它建立的_book目錄中。ui

(二)GitHub Pages配置code

  1. 在github建立一個名爲 gitbook的倉庫,同時在該倉庫建立 gh-pages 分支(將該gh-pages分支做爲GitHub Pages的發佈源)。htm

  2. 將本地_book目錄中的內容推送到 gitbook的倉庫的 gh-pages 分支,而後咱們即可以經過 https://userName.github.io/gitbook/ 來訪問咱們的gitbook.github-pages

(三)平常編輯!!!<<==文檔

  1. 使用 Gitbook Editor 或者 Typora 編輯md文檔。
  2. 執行命令gitbook build進行構建,而後推送到 gitbook的倉庫的 gh-pages 分支。
    (本人目前通常是 先構建至_book目錄,而後複製到本地的克隆倉庫目錄,再在倉庫目錄內進行推送)
相關拉取/推送命令:

將 github項目的 gh-pages分支 克隆到 本地的某目錄 以下:get

git clone -b gh-pages https://github.com/zhongyuanzhao000/gitbook.git "D:Wiki\gh-pages"

使用 git clone 命令複製的項目須要 更新並推送時,

cd <project目錄>        
git add *                     # 提交全部更改信息(刪除 增長文件)
git commit -m "update"        # 提交更改文件的標籤
git push origin gh-pages      # 推送到gh-pages分支
相關文章
相關標籤/搜索