跳转至

快速开始

1. 安装环境

pip install mkdocs-material

如需锁定版本,可以使用 pip install "mkdocs-material>=9,<10"

2. 本地预览

在项目根目录执行:

mkdocs serve

默认地址为 http://127.0.0.1:8000,保存 Markdown 文件后浏览器会自动刷新。

3. 构建静态站点

mkdocs build

编译结果会输出到 site/ 目录,可部署至任意静态资源托管平台。

4. 常用命令速查

命令 作用
mkdocs new [DIR_NAME] 初始化全新项目
mkdocs serve 启动本地调试服务器
mkdocs build 构建静态文件
mkdocs gh-deploy 部署到 GitHub Pages