diff --git a/editor/live-preview.mdx b/editor/live-preview.mdx index 909c8204d..1363e5bc5 100644 --- a/editor/live-preview.mdx +++ b/editor/live-preview.mdx @@ -4,13 +4,17 @@ description: "Preview your documentation site and see changes in real time as yo keywords: ["preview"] --- -Preview your documentation site in real time as you make changes in the web editor. Live previews show your site exactly as it appears when published, without creating a preview deployment. +Preview your documentation site in real time as you make changes in the web editor. Live previews open in a separate browser window and show your site exactly as it appears when published, without creating a preview deployment. -- **Content changes**: See new and edited pages. -- **Configuration updates**: View color, theme, logo, and other changes instantly. +- **Content changes**: See new and edited pages update instantly. +- **Configuration updates**: View color, theme, logo, and other changes in real time. - **Navigation structure**: Preview how navigation items appear in the sidebar and tables of contents. - **Component changes**: See how components render with your content. + + Live preview requires keeping both the editor and preview windows open. Changes sync automatically between windows as you edit. + + ## Live previews versus preview deployments Both features let you preview changes before publishing, but serve different purposes. @@ -18,7 +22,7 @@ Both features let you preview changes before publishing, but serve different pur | | Live preview | Preview deployment | |---------|--------------|-------------------| | **Speed** | Instant | Requires build time | -| **Access** | In the editor | Shareable URL | +| **Access** | Separate window (local only) | Shareable URL | | **Use case** | View changes while editing | Share with team for review | | **Availability** | While editor is open | Persists until closed | @@ -26,7 +30,7 @@ Use live preview for immediate feedback as you work. Create preview deployments ## Enable live preview -Click the button in the toolbar to open a live preview of your site in the editor. +Click the button in the toolbar to open a live preview of your site in a new browser window. button in the toolbar to open a live preview of /> +The preview window opens alongside your editor and updates automatically as you make changes. Keep both windows open to see your edits in real time. + - Live preview is only available for public documentation. If your documentation requires authentication, the editor displays a "Live preview unavailable" message. + Live preview is currently **local only** and requires keeping both the editor and preview windows open in the same browser session. For shareable previews that your team can access, [upgrade your plan](/deploy/preview-deployments) to use preview deployments. + + + Live preview is not available for documentation that requires authentication. If your documentation uses auth, the preview window will not display content. +