MkDocs 安装

详细指南。

---

要求

MkDocs 需要系统上安装最新版本的 Python 和 Python 包管理器 pip。

你可以从命令行检查是否已经安装了这些：

$ python --version
Python 3.8.2
$ pip --version
pip 20.0.2 from /usr/local/lib/python3.8/site-packages/pip (python 3.8)

如果已经安装了这些包，你可以跳到 安装 MkDocs。

安装 Python

使用你选择的包管理器安装 Python，或者从 python.org 下载适用于你系统的安装程序并运行它。

注意： 如果你在 Windows 上安装 Python，请确保在安装程序提供此选项时勾选“将 Python 添加到 PATH”（默认情况下通常是关闭的）。

安装 pip

如果你使用的是较新版本的 Python，Python 包管理器 pip 很可能默认已经安装。然而，你可能需要将其升级到最新版本：

pip install --upgrade pip

如果你需要首次安装 pip，请下载 get-pip.py。然后运行以下命令进行安装：

python get-pip.py

安装 MkDocs

使用 pip 安装 mkdocs 包：

pip install mkdocs

现在你应该已经在系统上安装了 mkdocs 命令。运行 mkdocs --version 检查是否一切正常。

$ mkdocs --version
mkdocs, version 1.2.0 from /usr/local/lib/python3.8/site-packages/mkdocs (Python 3.8)

注意： 如果你希望为 MkDocs 安装手册页，click-man 工具可以为你生成并安装它们。只需运行以下两个命令：

pip install click-man
click-man --target path/to/man/pages mkdocs

查看 click-man 文档 了解为什么手册页没有被 pip 自动生成和安装。

注意： 如果你使用的是 Windows，上述某些命令可能无法直接使用。

一个快速的解决方案可能是在每个 Python 命令前加上 python -m，如下所示：

python -m pip install mkdocs
python -m mkdocs

对于更永久的解决方案，你可能需要编辑你的 PATH 环境变量，以包含 Python 安装目录中的 Scripts 目录。较新版本的 Python 包含一个为你执行此操作的脚本。导航到你的 Python 安装目录（例如 C:\Python38\），打开 Tools，然后是 Scripts 文件夹，双击运行 win_add2path.py 文件。或者，你可以下载 脚本 并运行它（python win_add2path.py）。