本地部署项目文档管理网站 MkDocs 并实现外部访问
MkDocs 是一款快速、简单且易于使用的静态站点生成器,它使用 Markdown 来编写文档,并将这些文档转换成静态网站,非常适合用于构建软件项目的文档网站,帮助团队更有效地分享信息和技术细节。本文将详细介绍如何在 Windows 系统本地部署 MkDocs 并结合路由侠实现外网访问本地部署的 MkDocs 。
第一步,本地部署安装 MkDocs
1,本教程操作环境为 Windows11 系统,首先确保你的系统上已经安装了 Python 3.x 。如果没有,请从 Python 官方网站下载并安装,点此下载。
2,打开命令提示符( CMD )或 PowerShell ,然后运行以下命令来安装 MkDocs 。
pip install mkdocs
3,在 CMD 或 PowerShell 中,用命令 cd 导航到你想要创建 MkDocs 项目的文件夹,然后运行以下命令。
mkdocs new my-project cd my-project
4,在项目目录下运行以下命令来启动本地开发服务器。
mkdocs serve
5,打开浏览器访问地址 http://127.0.0.1:8000 ,就能看到你创建的 MkDocs 项目了。
第二步,外网访问本地 MkDocs
在内网的电脑上安装路由侠,点此下载
1,下载安装完成后,打开路由侠界面,点击【内网映射】。
2,点击【添加映射】。
3,选择【原生端口】。
4,在内网端口填写 MkDocs 端口 8000 后点击【创建】按钮,如下图。
5,创建好后,就可以看到一条映射的公网地址,鼠标右键点击【复制地址】。
6,在外网电脑上,打开浏览器,在地址栏输入从路由侠生成的外网地址,就可以看到内网部署的 MkDocs 界面了。