跳转到内容

介绍

@docs-islands/vitepress 适合以内容为主、只在少数位置需要交互组件的 VitePress 站点。它让你在 Markdown 里直接放入 React 组件,同时继续沿用 VitePress 的页面、路由、主题和静态生成流程。

它解决什么问题

当站点里只有少量交互区域时,单独再搭一层前端应用通常会让结构变重。@docs-islands/vitepress 把问题收敛到组件级别:你可以复用现有 React 组件,为每个组件单独选择渲染策略,并在 SPA 切页时尽量减少视觉闪烁。

适合什么场景

它更适合文档站、产品介绍页和内容站。这类站点仍然以静态输出、SEO 和稳定阅读体验为主,只在局部需要搜索框、演示组件、可视化卡片或交互示例。

不适合什么场景

如果页面主体本身就是完整应用,或者组件之间依赖复杂的跨框架共享状态,这个包就不是合适的主架构。它也不会替代应用级路由、数据流或应用壳设计。

它和 VitePress 的分工

部分负责内容
VitePress页面路由、主题、 Markdown 渲染与静态站点生成。
docs-islands识别 Markdown 中的 React 标签,生成渲染容器,并按指令决定预渲染或客户端接管方式。
React 运行时只在需要交互的容器上接管,不接管整页。

根据 MIT 许可证发布。 (0826c60)

Global Debug Console

docs-islands Runtime Globals

Browse the runtime globals injected by @docs-islands/vitepress and inspect their current live values.

Console helper: window.__DOCS_ISLANDS_SITE_DEVTOOLS__.getGlobal('__PAGE_METAFILE__')

Injected Globals

VitePress runtime site data. Hidden in dev and MPA mode.