Mkdocs 安裝啟用
在開始撰寫 MkDocs 筆記之前,我們需要先在本地電腦建立運行環境。MkDocs 是基於 Python 開發的工具,因此安裝過程非常簡便。在此我會以 Microsoft 推出的整合開發環境 Visual Stuido Code 為例來操作。
系統需求
- Python 3.8 或更高版本
- pip (Python 的套件管理工具)
確認 Python 環境
請開啟終端機(Windows 使用命令提示字元或 PowerShell,Mac/Linux 使用 Terminal),輸入以下指令確認版本:
如果正確顯示版本號,代表環境已就緒。
安裝 MkDocs
- 創建專案資料夾:開啟專案資料夾,在此我直接創建一個資料夾叫做
my-mkdocs-project - 安裝 MkDocs:在終端機中輸入安裝 MkDocs 指令
- 建立網站結構:在
my-mkdocs-project下新增一個mkdocs.yml及doc的子資料夾,在doc內加入一個index.md作為首頁 mkdocs.yml請輸入基本資訊,日後再逐步擴增index.md可以先留白,或嘗試用簡單的 Markdown 語法寫一些東西,例如
啟動預覽伺服器
MkDocs 最強大的功能之一就是即時預覽。在專案根目錄下執行:
執行後,終端機會顯示一個網址(通常是 http://127.0.0.1:8000/)。請將此網址輸入瀏覽器,你就能看到初步生成的網站。當你修改 docs/ 下的 Markdown 檔案並按下儲存時,網頁內容會自動更新,不需要重新整理。