mdBook 是一個基於 Markdown 文件的靜態站點生成器,可以用於快速創建個人博客、文件頁面或網站。下面是使用 mdBook 部署自己的網站的簡要步驟:
-
創建 mdBook 項目:在你的本地電腦上創建一個新的 mdBook 項目,可以使用以下命令:
mdbook init mysite ``` 這將在當前目錄下創建一個名為"mysite"的新項目。
-
編寫 Markdown 文件:在 mdBook 項目的 "src" 文件夾中編寫 Markdown 格式的文檔,這些文檔將被自動轉換為 HTML 頁面。可以使用 Markdown 語法編寫文檔內容,也可以使用 mdBook 提供的一些特殊語法來設置頁面佈局、添加導航等。
-
預覽站點:在本地預覽生成的站點,可以使用以下命令:
mdbook serve --open
這將啟動一個本地服務器,讓你在瀏覽器中預覽生成的站點,可以通過訪問http://localhost:3000來查看。
-
構建網站:當你滿意站點的外觀和內容後,可以使用以下命令構建最終的靜態網站文件:
mdbook build ``` 這將生成一個名為"dist"的文件夾,其中包含生成的HTML、CSS、JavaScript等文件。
-
部署網站:將生成的 "dist" 文件夾上傳到你的 Web 服務器或靜態托管平台,例如 GitHub Pages、Netlify 等,即可將你的網站部署到互聯網上。
這裡將你的倉庫上傳到 GitHub 之後,點擊 Setting,找到裡面的 Pages。這裡我們將使用 GitHub Pages 來部署網站。
之後操作 Build and Deployment,Source 的來源選擇 GitHub Action。
之後點擊 mdBook 中的 Configure,我們使用這裡面的默認配置就可以。
之後提交完代碼,等待 GitHub Action 運行結束我們就有了自己的網站主頁了。