Skip to content

靜態網站托管入門

約 2842 字大約 36 分鐘

GitHub Actions部署教程

2025-08-01

前置條件

喺開始之前,您只需要準備兩樣嘢:

  1. GitHub 賬戶:如果您還冇,請喺 GitHub.com 免費註冊。呢將會係您代碼嘅中心樞紐。

  2. 簡單網站項目:計算機上包含網站文件嘅文件夾。如果您還冇,請創建一個名為 my-first-website 嘅文件夾,並喺其中創建一個名為 index.html 嘅文件,內容如下:

    index.html

GitHub Pages

呢種方法直接從您嘅 GitHub 倉庫托管網站。佢非常簡單,同 GitHub 生態系深度集成,係完美嘅起點。

GitHub Pages 分步部署指南

  1. 創建新嘅 GitHub 倉庫

    倉庫(或"repo")係托管喺 GitHub 上嘅項目文件夾。呢係您網站代碼嘅存放地。

    • 登錄 GitHub 並轉到您嘅儀表板。

    • 喺右上角,點擊 + 圖標並選擇 New repository

    • 填寫表單,詳細信息如下:

      倉庫名稱Requiredstring

      輸入一個唯一嘅名稱,如 my-first-website。GitHub 將喺您網站嘅 URL 中使用呢個名稱。

      描述Optionalstring

      簡要描述您嘅項目,例如:"我嘅第一個上線網站,使用 GitHub Pages 部署!"。

      公開 / 私有Required

      選擇 Public。免費嘅 GitHub Pages 從公開倉庫托管。

      添加 README 文件Optionalboolean

      添加 README 文件嚟描述您嘅項目係個好習慣。您可以勾選呢個框。

      ::::

    • 點擊綠色嘅 Create repository 按鈕。

  2. 上傳您嘅網站文件

    倉庫創建完成后,而家可以添加您嘅網站文件了。

    • 喺新倉庫嘅主頁上,點擊 Add file 按鈕並選擇 Upload files
    • 將您嘅 index.html 文件(或整個項目文件夾)拖放到指定區域。
    • 喺上傳區域下方,您會找到 Commit changes 部分。"commit" 係您更改嘅快照。
    • 輸入簡潔嘅提交消息,如 feat: 添加初始網站文件
    • 點擊 Commit changes
  3. 激活 GitHub Pages

    而家,您只需要告訴 GitHub 將呢啲文件作為網站提供服務。

    • 喺您嘅倉庫中,點擊 Settings 標籤。
    • 喺左側邊欄中,點擊 Pages
    • Build and deployment 下,對於 Source,選擇 Deploy from a branch
  4. 配置同保存

    告訴 GitHub 哪個分支同文件夾包含您嘅網站。

    • Branch:從下拉菜單中選擇 main。呢係您倉庫嘅主分支。
    • Folder:選擇 /(root)。呢告訴您嘅 index.html 喺主目錄中。
    • 點擊 Save
  5. 訪問您嘅在線網站!

    GitHub 而家正在構建同部署您嘅網站。呢個過程稱為"GitHub Action",可能需要一兩分鐘。

    • 短暫等待后,刷新 Pages 設置頁面。
    • 項部將出現一個綠色框:"您嘅網站已上線於 https://<您嘅 GitHub 用戶名>.github.io/<您嘅倉庫名稱>/"。
    • 點擊鏈接查看您嘅"Hello, World!"消息喺互聯網上實時顯示!

    請耐心等待!

    有時您嘅網站可能需要 5-10 分鐘先至首次顯示。如果您看到 404"Not Found"錯誤,請稍等片刻,清除瀏覽器緩存,然後重試。

使用 GitHub Actions 自動化部署

手上上傳對於入門嚟講好,但現代 Web 開發嘅真正力量喺於自動化。通過使用 GitHub Actions 工作流程,您可以設置一個過程,每次向 main 分支推送更改時自動構建同部署您嘅網站。

呢被稱為持續集成/持續部署(CI/CD)嘅最佳實踐。

設置您嘅自動部署工作流程

  1. 創建工作流程目錄

    GitHub Actions 工作流程由位於倉庫內特殊目錄中嘅 YAML 文件定義。

    • 喺項目嘅根文件夾中,創建一個名為 .github 嘅新文件夾。
    • .github 內,創建另一個名為 workflows 嘅文件夾。
  2. 創建工作流程文件

    .github/workflows 目錄中,創建一個名為 deploy.yml 嘅新文件。

  3. 添加工作流程代碼

    將以下代碼複製粘貼到您嘅 deploy.yml 文件中。呢係 VuePress 網站嘅標準工作流程。

    .github/workflows/deploy.yml
  4. 提交並推送工作流程文件

    保存 deploy.yml 文件,將其提交到您嘅倉庫,並推送到 GitHub。

    git add .github/workflows/deploy.yml
    git commit -m "ci: 添加 GitHub Actions 部署工作流程"
    git push
  5. gh-pages 分支配置 GitHub Pages

    工作流程將自動創建一個名為 gh-pages 嘅新分支,並將您構建嘅網站文件推送到其中。您需要告訴 GitHub Pages 使用呢個分支。

    • 轉到您倉庫嘅 Settings > Pages
    • Build and deployment 下,將 Source 更改為 Deploy from a branch
    • Branch 更改為 gh-pages,文件夾更改為 /(root)
    • 點擊 Save
  6. 觀睇魔法發生

    從而家開始,每次您向 main 分支推送更改時,工作流程都會自動運行。您可以喺 GitHub 倉庫嘅 Actions 標籤下查看其進度。佢將構建您嘅網站並將完成嘅產品部署到您嘅在線 GitHub Pages URL。

問答同故障排除

以下係您可能遇到嘅一些常見問題同問題嘅答案。

為什麼我嘅網站顯示 404 Not Found 錯誤?

  • 等待幾分鐘:部署可能需要時間喺整個網絡上傳播呢。呢係最常見嘅原因。請俾佢 5-10 分鐘,特別係第一次部署時。
  • 檢查文件路徑:確保您嘅主 HTML 文件名為 index.html。如果您使用框架,請驗證 Build output directory 是否正確。對於標準 VuePress 網站,佢應該係 docs/.vuepress/dist
  • 檢查倉庫可見性:對於 GitHub Pages 免費版本,您嘅倉庫必須設置為 Public
  • 檢查您嘅分支:確保您部署嘅分支(maingh-pages)係托管提供商設置中選擇嘅分支。

我嘅 CSS 或 JavaScript 冇有加載。為什麼?

  • 路徑唔正確:呢係最可能嘅原因。檢查 HTML 中嘅 hrefsrc 路徑。相對路徑(/style.css../scripts/main.js)通常係最可靠嘅。
  • 區分大小寫:Web 服務器通常區分大小寫。style.css 係同 Style.css 唔同嘅文件。仔細檢查您嘅文件名同路徑嘅大小寫是否正確。
  • 構建問題:如果您使用框架,構建過程可能未能包含您嘅資源。檢查 GitHub Actions 或 Cloudflare Pages 中嘅構建日志是否有錯誤。

如何使用自定義域名?

兩個平台都為自定義域名提供咗出色嘅支持。

  • 對於 GitHub Pages:轉到 Settings > Pages > Custom domain,輸入您嘅域名(例如 www.yourdomain.com),然後保存。然後,轉到您嘅域名註冊商網站,添加 GitHub 提供嘅 CNAMEA 記錄。
  • 對於 Cloudflare Pages:喺您嘅 Pages 項目中,轉到 Custom domains 標籤並按照設置向導操作。如果您域名嘅 DNS 已經由 Cloudflare 管理,呢個過程係無縫嘅,通常即時完成。

我應該使用 GitHub Pages 還係 Cloudflare Pages?

更新日誌

2025/8/6 清晨7:12
查看所有更新日誌
  • 58574-feat: add Traditional Chinese documentation and components for various courses and personal pages