Chirpy 是適用于技術寫作的簡約、響應迅速且功能豐富的 Jekyll 主題,文檔地址:https://chirpy.cotes.page/ ,Github 地址:jekyll-theme-chirpy
。
1.開始
-
打開 chirpy-starter 倉庫,點擊按鈕
Use this template
-->Create a new repository
。 -
將新倉庫命名為
<username>.github.io
,其中<username>
是你的 GitHub 用戶名,如果包含大寫字母需要轉換為小寫。
2.安裝依賴
使用 git clone
將新創建的倉庫克隆到本地,并在項目根目錄下執行 bundle
命令安裝依賴。如果速度過慢可以使用以下命令,移除默認源并添加新的鏡像源。
bundle config mirror.https://rubygems.org https://gems.ruby-china.com
3. 配置
根據需要更新 _config.yml
中的變量,例如 url
、avatar
、timezone
、lang
等。
4.本地啟動
如果要在本地預覽網站內容,執行以下命令:
bundle exec jekyll serve
在瀏覽器訪問 http://127.0.0.1:4000/。
5.部署
GitHub Pages 是一個通過 GitHub 托管和發布網頁的服務,官方文檔:https://docs.github.com/en/pages。在部署之前,需要將 _config.yml 文件中的 url 配置為https://<username>.github.io
。
之后在 GitHub 上打開倉庫設置,點擊左側導航欄 Pages
,在 Build and deployment
- Source
下拉列表選擇 GitHub Actions
。
提交本地修改并推送至遠程倉庫,將會觸發 Actions 工作流。在倉庫的 Actions 標簽頁將會看到 Build and Deploy 工作流正在運行。構建成功后,即可通過配置的 URL 訪問自己的博客網站。
6.評論系統
Jekyll 生成的博客網站是靜態的,沒有后端和數據庫,因此本身無法實現評論功能。然而,可以使用 disqus、utterances 和 giscus 等評論系統來實現評論功能。
本文使用 giscus,它是利用 GitHub Discussions 實現的評論系統,并且是開源、免費的。開啟評論系統的步驟如下。
(1) 安裝 giscus app,訪問 https://github.com/apps/giscus 點擊右側的 install 按鈕進行安裝即可。
(2) 在倉庫設置頁面 Features 一節中勾選 Discussions,開啟倉庫的 GitHub Discussions 功能。
(3) 在倉庫的 Discussions 標簽頁,點擊 Categories 旁邊的編輯按鈕,自定義用于博客評論的類別名稱(例如 Comments)。
(4) 打開 https://giscus.app/zh-CN,按以下配置:
- 倉庫:
<username>/<username>.github.io
- 頁面 <–> discussion 映射關系:勾選
Discussion 的標題包含頁面的 pathname
- Discussion 分類:
選擇上一步創建的類別名稱 Comments
之后找到啟用 giscus,將生成的配置填寫到 _config.yml 文件中 comments.giscus 的對應選項。
comments:active: giscusgiscus:repo: ZZy979/zzy979.github.iorepo_id: R_kgDxxxxxxcategory: Commentscategory_id: DIC_kwDOxxxxxxxxxmapping: pathname
重啟 Jekyll 服務器,在文章底部將會看到評論區,使用 GitHub 賬號登錄即可發表評論。