嵌入模式

在 iframe 或仪表板中嵌入文档时隐藏页头和页脚

以 Markdown 格式查看

嵌入模式会从文档页面中移除页头和页脚,使其适合嵌入到 iframe、仪表板或其他只想显示内容的环境中。

启用嵌入模式

在任何文档 URL 中添加 embedded=true 查询参数:

https://docs.example.com/getting-started?embedded=true

启用时,页头(包括导航和标志)和页脚将被隐藏,主要内容区域会调整以填充可用空间。

持久性

一旦激活嵌入模式,它会在同一会话的导航事件中保持持久。用户可以在页面之间导航,无需在每个 URL 中添加查询参数。

使用场景

嵌入模式在以下情况下很有用:

  • 在产品仪表板或管理面板中显示文档
  • 在 iframe 中嵌入文档时创建无缝体验
  • 显示文档内容而不显示标准导航框架