欢迎使用 MkDocs Material¶
这是一个使用 MkDocs 和 Material for MkDocs 主题构建的精美文档网站。
特性概览¶
快速开始¶
# 安装 MkDocs 和 Material 主题
pip install mkdocs-material
# 创建新项目
mkdocs new my-project
cd my-project
# 启动开发服务器
mkdocs serve
然后访问 http://127.0.0.1:8000 即可预览你的网站！
项目结构¶
my-project/
├── docs/
│ ├── index.md # 首页
│ └── ... # 其他文档页面
├── mkdocs.yml # 配置文件
└── site/ # 构建输出目录
常用命令¶
| 命令 | 说明 |
|---|---|
mkdocs serve |
启动开发服务器 |
mkdocs build |
构建静态网站 |
mkdocs gh-deploy |
部署到 GitHub Pages |
提示
开发服务器支持热重载，保存文件后浏览器会自动刷新！