Project Summary
先看结果,再看过程。
基于 Astro + MDX 构建的静态文档网站,支持全文搜索、暗色模式和多版本切换,部署在 Cloudflare Pages。
项目类型
Web
发布时间
2025
交付内容
可访问成品
可查看资料
线上版本 + 源码
这个项目源于一个真实痛点:内部 API 文档散落在 Notion、Confluence、README 三处,维护成本极高。
为什么选 Astro
文档站对 JS 的需求极少,Astro 的岛屿架构完美契合——只在搜索框、代码高亮等交互组件上激活 JS,其余完全静态,Lighthouse 性能分全满。
内容层
所有文档以 MDX 格式存储,通过 Astro Content Collections 做类型安全的内容管理。自定义 MDX 组件实现了带复制按钮的代码块、参数表格、折叠面板等文档专用元素。
全文搜索
使用 Pagefind 实现本地全文搜索,无需外部服务,构建时自动生成搜索索引,搜索结果实时高亮。
部署
通过 GitHub Actions 自动触发构建,推送到 Cloudflare Pages,全球 CDN 分发,首字节时间稳定在 50ms 以内。