GitHub 頁面

GitHub 為使用者或組織和專案站點提供無限託管服務。Jekyll 和靜態檔案都可用。

以下是在 Github 上託管你的 Jekyll 部落格的步驟。

建立

使用者或組織網站

  1. 建立一個名為 username.github.io 的儲存庫,其中 username 是你在 GitHub 上的使用者名稱(或組織名稱)。

  2. 將儲存庫克隆到你的計算機上:

    $ git clone https://github.com/username/username.github.io
    
  3. 輸入專案資料夾,載入程式 ,設計和除錯你的站點:

    $ cd username.github.io
    $ bundle install
    $ bundle exec jekyll serve
    
  4. 提交併推送儲存庫:

    $ git add --all
    $ git commit -m "Initial commit"
    $ git push -u origin master
    

現在你應該可以訪問 username.github.io 來檢視你的部落格。

專案現場

可以在包括私有儲存庫的每個儲存庫中啟用專案站點。

  1. 啟用專案站點。

    轉到 Settings-GitHub Pages-Sources,選擇一個源來開啟儲存庫的 GitHub 頁面。

  2. 建立網站

    你可以從頭開始構建一個 Jekyll 站點,或使用 Theme Chooser 為專案站點查詢主題。

  3. 編輯內容

  4. 承諾

現在你應該可以訪問 username.github.io/your-project 檢視你的專案站點。

自定義域

  1. 開啟設定 - > GitHub 頁面 - >自定義域,新增自定義域。

  2. 建立 CNAME 檔案:

    $ cd username.github.io
    $ echo "example.com" > CNAME
    
  3. 承諾並推動

    $ git commit -m "Add CNAME" CNAME
    $ git push -u origin master
    

限制

外掛

Jekyll 有一個帶鉤子的外掛系統,允許你建立特定於你的站點的自定義生成內容。但是,出於安全原因,GitHub Pages 僅允許插入白名單。

這是白名單:

  • Jekyll Sitemap
  • Jekyll SEO 標籤
  • GitHub 的後設資料
  • 傑基爾飼料
  • Jekyll 重定向自
  • Jemoji
  • 傑基爾提到

為避免與 GitHub 頁面不一致,你可以使用 --safe 在本地服務。

你仍然可以通過將生成的站點發布到 GitHub 頁面來使用所有外掛,方法是在本地轉換站點並將生成的靜態檔案推送到 GitHub 儲存庫而不是 Jekyll 原始檔。

降價引擎

自 2016 年 5 月 1 日起,GitHub Pages 僅支援 kramdown 作為 Markdown 引擎。

有關更多詳細資訊,請參閱 https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0

來源

GitHub 允許你將 Jekyll 源設定為 master 分支中的 master 分支,gh-pages 分支或/docs 資料夾。

有關完整的教程,請訪問 https://pages.github.com/