Mkdocs教程
python 虚拟环境使用
mkdocs安装
mkdocs命令
mkdocs配置文件
mkdocs内嵌Open WebUI
mkdocs站点构建
本文档使用 MrDoc 发布
-
+
首页
mkdocs站点构建
想要使用 MkDocs 生成静态站点文件，最核心的命令非常简单。你需要在项目的根目录（即包含 `mkdocs.yml` 文件的目录）下运行以下命令： ## 核心生成命令 ```bash mkdocs build ``` ### 命令详解 运行此命令后，MkDocs 会执行以下操作： 1. **解析**：读取 `mkdocs.yml` 配置文件。 2. **转换**：将 `docs/` 目录下的所有 Markdown 文件转换为 HTML。 3. **打包**：默认在项目根目录下创建一个名为 **`site/`** 的文件夹，并将生成的 HTML、CSS、JS 以及图片等资源放入其中。 --- ## 常用进阶参数 在实际操作中，你可能会用到以下几个变体： | 命令 | 用途 | | --- | --- | | `mkdocs build --clean` | **清理构建**。在生成新文件前先删除旧的 `site/` 目录，确保没有残留的废弃文件。 | | `mkdocs build --directory-res [dir]` | **指定输出目录**。如果你不想生成到 `site/`，可以用这个参数更改路径。 | | `mkdocs build --strict` | **严格模式**。如果遇到断链或配置错误，会直接停止构建并报错，适合 CI/CD 环境。 | --- ## 补充：实时预览 如果你是在编写内容过程中想看看效果，而不是为了最终部署，建议使用： ```bash mkdocs serve ``` 这会启动一个本地服务器（通常是 `http://127.0.0.1:8000`），每当你保存 Markdown 文件时，页面会自动刷新预览。 > **小贴士**：生成的 `site/` 目录就是完整的静态网站，你可以直接将它上传到 GitHub Pages、Nginx 或任何静态托管平台。
koalalove
2026年2月10日 19:04
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
分享
链接
类型
密码
更新密码