跳至主要内容
五折优惠 全部方案,限时优惠。起价 $2.48/mo
MkDocs

MkDocs

MkDocs 只需一个 YAML 配置文件,就能把一个 Markdown 文件夹变成文档站点。它自带实时重载的开发服务器,并输出可托管在任何地方的纯静态 HTML。采用 BSD-2-Clause 许可,GitHub 星标 22,300+。

快速概览

22.4k

GitHub star 数

1

页面浏览量

许可 BSD-2-Clause 版本 Latest OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV4,IPV6

访问

  • 打开: http://SERVER_IP

编辑并发布内容

1. 添加或编辑 Markdown 文件: /opt/mkdocs/docs

2. 如果你新增或重命名页面,请更新 /opt/mkdocs/mkdocs.yml for navigation.

3. 重新构建站点:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

Nginx 从以下位置提供生成的文件: /opt/mkdocs/site

重新构建后无需重启 Nginx。

重要路径

  • 项目: /opt/mkdocs
  • 内容: /opt/mkdocs/docs
  • 配置: /opt/mkdocs/mkdocs.yml
  • 构建输出: /opt/mkdocs/site
  • Python 虚拟环境: /opt/mkdocs/venv
  • MkDocs 可执行文件: /opt/mkdocs/venv/bin/mkdocs
  • Nginx 配置: /etc/nginx/sites-available/mkdocs.conf

域名与 HTTPS

1. 将你的域名指向服务器 IP 地址。

2. 编辑 Nginx 配置并替换 server_name _; 为你的域名(例如 server_name <YOUR_DOMAIN>;):

vim /etc/nginx/sites-available/mkdocs.conf

3. 测试配置:

nginx -t

4. 安装 Certbot:

apt install -y certbot python3-certbot-nginx

5. 生成 Let's Encrypt 证书:

certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>

6. 重新加载 Nginx:

systemctl reload nginx

7. 更新 MkDocs 站点 URL:将 site_url: 'http://<SERVER_IP>/' 替换为 site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. 重新构建站点:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

9. 打开浏览器,访问: https://<YOUR_DOMAIN>

注意事项

  • Markdown 的更改需重新构建后才会出现在公开网站上。
  • Nginx serves the generated files from /opt/mkdocs/site.
  • 修改 mkdocs.yml 以及项目配置,按你的偏好调整。

更多开发工具

相关应用。

立即部署 MkDocs。 起价 $2.48/月。