跳转至

安装

环境要求

  • Python 3.7 或更高版本
  • pip 包管理器

安装 MkDocs

pip install mkdocs

安装 Material 主题

pip install mkdocs-material

验证安装

mkdocs --version

你应该能看到 MkDocs 的版本号。

创建新项目

mkdocs new my-project
cd my-project

启动开发服务器

mkdocs serve

访问 http://127.0.0.1:8000 查看你的文档网站。

注意

Material 主题已经包含了很多有用的扩展,如代码高亮、表格、提示框等。

构建静态文件

mkdocs build

构建后的文件将在 site 目录中。