开始使用¶
Material for MkDocs 是一个强大的文档框架，基于 MkDocs，这是一个用于项目文档的静态网站生成器。1 如果你熟悉 Python，可以使用 pip（Python 包管理器）来安装 Material for MkDocs。如果不熟悉，我们建议使用 docker。
安装¶
使用 pip 推荐¶
Material for MkDocs 作为一个 Python 包 发布，可以通过 pip 安装，最好使用 虚拟环境。打开终端并使用以下命令安装 Material for MkDocs：
-
Material for MkDocs 使用 语义版本控制2，因此限制升级到当前主要版本是一个好主意。
这将确保你不会意外地 升级到下一个主要版本，这可能会包含破坏性更改，从而悄然损坏你的站点。此外，你可以使用
pip freeze创建一个锁定文件，以便始终可重现构建：现在，锁定文件可以用于安装：
这将自动安装所有依赖项的兼容版本：MkDocs、Markdown、Pygments 和 [Python Markdown Extensions]。Material for MkDocs 始终努力支持最新版本，因此无需单独安装这些软件包。
如何设置 Material for MkDocs by @james-willett – 27分钟 – 学习如何使用 Material for MkDocs 在 GitHub Pages 上创建和托管文档网站的逐步指南。
Tip
如果你没有 Python 的使用经验，我们建议阅读 使用 Python 的 pip 管理项目依赖项，这是一篇非常好的介绍，讲解了 Python 包管理的机制，并帮助你在遇到错误时进行故障排除。
使用 docker¶
官方 Docker 镜像 是快速启动的好方法，因为它预装了所有依赖项。打开终端并使用以下命令拉取镜像：
mkdocs 可执行文件作为入口点提供，serve 是默认命令。如果你对 Docker 不熟悉，不用担心，后面的章节会为你提供帮助。
以下插件与 Docker 镜像捆绑在一起：
Warning
Docker 容器仅用于本地预览目的，不适合用于部署。这是因为 MkDocs 用于实时预览的 Web 服务器并不是为生产使用而设计，可能存在安全漏洞。
如何将插件添加到 Docker 镜像中？
Material for MkDocs 仅捆绑选定的插件，以保持官方镜像的体积小。如果你想使用的插件不包含在内，可以轻松添加。创建一个 Dockerfile 来扩展官方镜像：
FROM squidfunk/mkdocs-material
RUN pip install mkdocs-macros-plugin
RUN pip install mkdocs-glightbox
接下来，使用以下命令构建镜像：
新镜像将安装额外的软件包，可以像官方镜像一样使用。
使用 git¶
Material for MkDocs 可以直接从 GitHub 使用，通过将仓库克隆到项目根目录的子文件夹中，这在你想使用最新版本时非常有用：
接下来，使用以下命令安装主题及其依赖项：