一、主要步驟

1. 安裝 MkDocs

   sudo apt install python3 python3-pip 		# 配置好 python3 環境的可省略
   pip3 install mkdocs
   

2. 使用

   mkdocs new YOUR_SITE_NAME	# 建立網站專案
   cd YOUR_SITE_NAME
   

   此時，這個目錄應該是如下結構：

   ├── docs
   │ └── index.md
   └── mkdocs.yml
   

   其中，docs 目錄是文件和其他資源儲存的目錄，mkdocs.yml 是配置檔案。

   若要建立新文件，在 docs 目錄中新建 MarkDown 檔案並在 mkdocs.yml

   中配置，可參考 MkDocs 文件

   mkdocs build	# 生成靜態網頁（在 site 目錄）
   mkdocs serve	# 預覽網頁（ https://localhost:8000
   

3. 美化

   pip3 install mkdocs-material	# 安裝 material 主題
   

   material 主題的具體使用參見 Material 主題文件

二、部署網站

1. 使用 GitHub Pages/Gitee Pages

   git init
   # git branch -m main
   git add . && git commit -m "MESSAGE"
   git remote add origin YOUR_SERVER_URL
   git push -u origin master # 或者是 git push -u origin main
    
   

2. 部署時請部署 site 目錄