为什么使用文档框架
文档框架让“写文档”变成“写 Markdown + 配置导航”,并解决搜索、主题、部署、版本化等工程问题。
主要收益
- 效率:内容即 Markdown,所见即所得预览,热更新。
- 信息架构:自动侧边栏/目录,支持分层导航。
- SEO 与性能:静态输出,首屏快,搜索引擎友好。
- 协作:与 Git 工作流协同;PR 审核、预览环境便捷。
- 扩展:插件/主题/MDX 组件,便于增加提示框、代码沙箱、图表。
- 版本/多语言:Docusaurus 原生版本化,多语言支持;VitePress/其他可通过路由/插件实现。
适用场景
- 产品/SDK/开放平台文档
- 开发者博客与指南
- 团队知识库、Runbook、SOP
不适合的场景
- 纯后端渲染的动态内容(需要数据库实时写入)
- 需要重度交互的 Web App(可用 Astro 混合,但非文档核心)***
