MkDocs 1
MkDocs — 用于快速、安全和可扩展网站的静态站点生成器。
静态站点简单
技术栈组成
DocsMkDocs 1
PythonPython 3.13
ThemeMaterial
为什么
构建时预渲染 HTML，实现最优性能和零服务器运行时。静态站点生成器（Astro、Eleventy）产生比 SSR 框架快 3-10 倍的页面。
Astro 的岛屿架构默认比 Next.js 少发 90% 的 JavaScript，Lighthouse 得分 95+。
何时使用
用于文档、博客和营销网站。动态用户特定内容用 SSR。
如何做
1. 安装 MkDocs
2. 编写内容 (MD/MDX)
3. 配置主题/模板
4. 构建并部署到 CDN
5. 添加环境配置 — cp .env.example .env && 编辑值
6. 运行测试 — npm test 或 pnpm test 验证设置
7. 部署 — git push 触发 CI/CD 或手动部署
示例
# MkDocs 构建
npx mkdocs build
# 输出在 dist/ 或 public/
// MkDocs — 使用示例
import { MkDocs } from "static-mkdocs";
const result = await mkdocs({ input: "data" });
console.log(result);
常见问题
- ⚠MkDocs 大站重建慢 — 使用增量构建
- ⚠无动态内容 — 需要时添加客户端 JS 或边缘函数
- ⚠环境间配置漂移 — 使用基础设施即代码（Terraform/Pulumi）保持 dev/staging/prod 一致
最佳实践
- ✓将 MkDocs 输出部署到 CDN 实现全球边缘缓存
- ✓用 {ne} 内容集合实现类型安全 frontmatter
- ✓设置健康检查和优雅关闭 — 处理 SIGTERM 以在退出前排空进行中的请求
常见问题解答
什么是MkDocs 1？适合做什么项目？
MkDocs — 用于快速、安全和可扩展网站的静态站点生成器。 它通过分层组合提供端到端类型安全与开箱即用的部署体验，适合从 MVP 到生产 SaaS 的快速迭代。
如何用MkDocs 1在 10 分钟内跑通一个 demo？
两步起步：① 安装 MkDocs；② 编写内容 (MD/MDX)。先跑通本地 dev server，再接一个真实数据源验证端到端链路。
MkDocs 1 最常见的坑是什么？怎么避免？
最高频的坑是：MkDocs 大站重建慢 — 使用增量构建。避免方法：在 PR 模板里加入对应 checklist，CI 中跑类型检查 + lint + 单测，三重把关再合并。
MkDocs 1 的最佳实践有哪些？
MkDocs 1 的最佳实践包括：将 MkDocs 输出部署到 CDN 实现全球边缘缓存；用 {ne} 内容集合实现类型安全 frontmatter；设置健康检查和优雅关闭 — 处理 SIGTERM 以在退出前排空进行中的请求。其中首条「将 MkDocs 输出部署到 CDN 实现全球边缘缓存」应在项目初始化时就落地，避免后期返工。
什么情况下不该选MkDocs 1？
三种情况另选他栈：① 团队对该栈核心框架零经验且工期紧张（学习曲线风险）；② 项目是纯内容/营销站（选 Astro 更轻）；③ 需要极高吞吐（>1 万 RPS）或强一致微服务（选 Go/Rust）。MkDocs 1 的强项是中高复杂度全栈与 API，别在简单静态页上过度工程。