MkDocs 是一款基于 Python 的静态网站生成工具，它简单易用，适合技术文档、API 文档或其他需要清晰结构的文档项目，专门用于快速构建项目文档。本文将详细介绍如何在 Linux 系统局域网内部署 MkDocs 并结合路由侠实现外网访问局域网内部署的 MkDocs 。
第一步，本地部署 MkDocs
1，本教程使用 Linux Ubuntu 系统进行演示，首先输入以下命令更新软件包列表。
sudo apt update
2，确保你的 Linux 系统已安装 Python3 和 pip ，如果未安装，可以使用以下命令安装。
sudo apt install python3 python3-pip
3，推荐创建虚拟环境安装 MkDocs 。
python3 -m venv ~/mkdocs-venv
激活虚拟环境。
source ~/mkdocs-venv/bin/activate
使用 pip 安装 MkDocs ，安装完成后，可以通过 mkdocs --version 检查是否安装成功。
pip install mkdocs -i https://pypi.tuna.tsinghua.edu.cn/simple
4，创建一个新的目录用于存放文档项目并进入该目录。
mkdocs new hello-mkdocs cd hello-mkdocs
在项目目录下运行以下命令启动开发服务器。
mkdocs serve --dev-addr=0.0.0.0:8000
5，打开浏览器访问地址 http://你的服务器 IP:8000 ，就能看到你部署的 MkDocs 站点界面了。
第二步，外网访问本地 MkDocs
安装路由侠内网穿透。
1，当前未提供网页管理，需要先在任意一台 Windows 机器安装路由侠 Windows 版本，用作跨机器管理。点此下载
2，在路由侠客户端主界面，进入“ 设备管理 ”，点击右下角的“ 添加设备 ”，此时可查看到对应的安装码，此安装码用于将设备添加到对应账号下，可选中后复制。
3，直接下载后导入：
wget https://dl.luyouxia.com:8443/v2/lyx-docker-x86_64.tar docker load -i lyx-docker-x86_64.tar
4，然后使用该镜像启动容器。
docker run --name lyx -it --restart=always --net=host -e code=这里填写安装码luyouxia/lyx
5，此时，需要等待下载和安装的过程，如果一切正常，最终可以看到一些输出，并且可以看到如下提示：
[Device] Logged in. Token: ....
这就表示安装成功了。
当前 Linux 终端这边，如果是使用的上面的命令，Docker 是运行在前台，此时可以按住 Ctrl + C ，退出路由侠，容器也将退出。现在可以使用以下命令将其放入后台持续运行：
docker start lyx
注意如果容器删除，重新 docker run ， 将创建为新的设备。
需要注意的是，因为容器参数已经添加了 --restart=always ，这样开机就会自动启动，不需要再手动启动路由侠了。
6，现在回到 Windows 这边设备列表，点击右上角的 × 返回主界面，再次进入，就可以找到这个设备，可以修改名称。
7，回到主界面，点击【内网映射】。
8，注意右上角的设备名称下拉框，这里选中刚刚添加的设备名称，此时在这个界面上添加的映射，就属于刚刚这个设备。添加或修改一般需要等待 30 秒，容器中的路由侠进程就会更新并加载。切换好设备后，点击【添加映射】。
9，选择【原生端口】。
10，在内网地址填写你的服务器 IP 和 MkDocs 端口 8000 后点击【创建】按钮，如下图。
11，创建好后，就可以看到一条映射的公网地址，鼠标右键点击【复制地址】。
12，在外网电脑上，打开浏览器，在地址栏输入从路由侠生成的外网地址，就可以看到内网部署的 MkDocs 站点界面了。
