news 2026/7/15 2:42:54

本地部署项目文档管理网站 MkDocs 并实现外部访问( Linux 版本)

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
本地部署项目文档管理网站 MkDocs 并实现外部访问( Linux 版本)

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 站点界面了。

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/6/30 20:32:51

孤悬东海的艺术秘境:大鹿岛的森林、礁石与岩雕传奇

在浙江台州以东的东海披山洋面上,有一座面积约两平方公里的岛屿,名为大鹿岛。它孤悬海上,距陆地约六海里。这座岛屿是国家4A级旅游景区,以的茂密森林、经海浪侵蚀形成的奇礁异石,以及遍布海岸的岩雕艺术,共…

作者头像 李华
网站建设 2026/7/1 23:50:44

PyTorch / CUDA 是什么?它们的关系?

背景: 最近跑 深度学习项目, 老是说装什么 Pytorch , CUDA 版本又多,装错一个版本都跑不起来,也实在不明白它们之间的关系 原理:

作者头像 李华
网站建设 2026/7/2 21:19:39

搬运机器人毕业设计

第2章 搬运机器人的总体方案 该设计的目的是为了设计一台物料搬运机器人,本章主要对搬运机器人的机械结构部分进行设计和分析。 2.1 总体设计的思路 设计机器人大体上可分为两个阶段: 1、系统分析阶段 ①根据系统的目标,明确所采用机器人的目…

作者头像 李华
网站建设 2026/7/8 1:23:34

【大数据毕设全套源码+文档】springboot基于大数据的亚健康人群数据可视化设计和实现(丰富项目+远程调试+讲解+定制)

博主介绍:✌️码农一枚 ,专注于大学生项目实战开发、讲解和毕业🚢文撰写修改等。全栈领域优质创作者,博客之星、掘金/华为云/阿里云/InfoQ等平台优质作者、专注于Java、小程序技术领域和毕业项目实战 ✌️技术范围:&am…

作者头像 李华