入门¶

Material for MkDocs是MkDocs的一个主题，MkDocs是一个用于生成静态页面的程序。如果熟悉Python的话，可以使用pip这个Python的包管理器来安装Material for MkDocs。如果不熟悉的话，推荐使用docker来安装。

安装过程中遇到问题，请查阅故障排除部分。

安装¶

使用pip¶

Material for MkDocs 可以使用pip来完成安装:

pip install mkdocs-material

pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git

这将自动安装所有依赖包的兼容版本：MkDocs，Markdown，Pygments和pymdown-extensions。Material for MkDocs始终致力于支持最新版本，因此无需单独安装这些软件包。

注意，要安装内测版本，您需要成为赞助商，创建个人访问令牌¹，并设置GH_TOKEN_值的环境变量到token's value。

使用docker¶

推荐使用官方的Docker镜像来快速安装，因为其已经预装了所有依赖。使用以下命令来拉取最新版本：

docker pull squidfunk/mkdocs-material

docker login -u ${GH_USERNAME} -p ${GH_TOKEN} ghcr.io
docker pull ghcr.io/squidfunk/mkdocs-material-insiders

mkdocs可执行文件作为入口点,且serve是默认的命令。如果不熟悉Docker也无需担心，后面的章节都会做详细的介绍。

以下插件与Docker镜像捆绑在一起：

• mkdocs-minify-plugin
• mkdocs-redirects

注意，要安装内测版本，您需要成为赞助商，创建个人访问令牌²，并设置GH_TOKEN_值的环境变量到token's value。

FROM squidfunk/mkdocs-material
RUN pip install ...

docker build -t squidfunk/mkdocs-material .

使用git¶

通过将存储库克隆到项目根目录的子文件夹中，可以直接从GitHub使用Material for MkDocs，如果是想使用最最新的版本，可以尝试此种方法：

git clone https://github.com/squidfunk/mkdocs-material.git

git clone git@github.com:squidfunk/mkdocs-material-insiders.git mkdocs-material

主题位于文件夹mkdocs-material/material中。 从git克隆时，必须自己安装所有必需的依赖包：

pip install -r mkdocs-material/requirements.txt

注意，要安装内测版本，您需要成为赞助商