如何使用 GitHub Pages 部署 Docusaurus,可以透過以下步驟,輕鬆地建立自己的網誌。
在開始之前,我們需要先確保以下條件都已經滿足:
首先,在 GitHub 上創建一個新的 Repository,用來存放網誌的代碼和部署文件。以下是創建 Repository 的步驟:
登錄 GitHub,進入主頁面。
點擊右上角的 “+” 按鈕,然後選擇 “New repository”。
在創建 Repository 的頁面中,填寫 Repository 名稱、描述和設置等信息,然後點擊 “Create repository” 按鈕創建 Repository。
接下來,我們需要下載 Docusaurus 的範本代碼,作為網誌的基礎。以下是下載 Docusaurus 範本的步驟:
在下載 Docusaurus 範本之後,我們需要進行安裝和測試,以確保網誌可以正常運行。以下是安裝和測試 Docusaurus 的步驟:
進入 my-blog 文件夾,打開命令行工具。
輸入以下命令,安裝 Docusaurus 和相關的依賴:
安裝完成後,輸入以下命令,啟動 Docusaurus 的本地測試服務:
在 Github 上建立新的 repository
在 Github 上建立一個新的 repository,命名為 {username}.github.io
,其中 username
是你的 Github 使用者名稱。例如,我的 Github 使用者名稱是 chatgpt
,因此我會命名我的 repository 為 chatgpt.github.io
。
將 Docusaurus 專案上傳至 Github
在你的電腦上開啟終端機(Terminal)或命令提示字元(Command Prompt),進入到 Docusaurus 專案的根目錄下,並執行以下指令:
其中,username
是你的 Github 使用者名稱,請注意要改成你自己的。這些指令的作用如下:
git init
:初始化 Git 儲存庫。git remote add origin git@github.com:{username}/{username}.github.io.git
:設定 Git 儲存庫的遠端位置。npm run build
:建立 Docusaurus 專案的靜態網頁檔案。npm run deploy
:將靜態網頁檔案上傳至 Github。在執行 npm run deploy
的時候,會需要你輸入 Github 的使用者名稱和密碼(或是 Personal Access Token)。請輸入正確的資訊後,等待上傳完成。
檢查網站是否正常運作
完成上傳後,打開瀏覽器,輸入 https://{username}.github.io
,其中 username
是你的 Github 使用者名稱,就可以看到你的 Docusaurus 網站了!如果你看到了你的網站,那就代表部署成功了。
編輯 Docusaurus 網站
現在,你可以開始編輯你的 Docusaurus 網站了。編輯完成後,只需要執行以下指令:
其中,Update website
是你的提交訊息,你可以自己替換成任何訊息。執行這些指令後,你的修改就會自動更新到你的 Github Pages 上了。
以上使用 Github Pages 部署 Docusaurus 教學,希望能幫助到您。