Live preview

Preview your documentation site in real time as you edit with the web editor’s side-by-side live preview and responsive viewport options.

Preview your documentation site as you edit. Live preview shows your pages exactly as they appear when published, updating in real time as you make changes to content, navigation, and configuration.

Open live preview

Click the play button in the toolbar to open a live preview in a new tab.

Live preview is only available for public documentation. If your documentation requires authentication, the editor displays a “Live preview unavailable” message.

Live preview versus preview deployments

	Live preview	Preview deployment
Speed	Instant	Requires build time
Access	Local URL	Shareable URL
Use case	View changes while editing	Share with team for review
Availability	While the editor is open	As long as the branch exists

Use live preview for immediate feedback as you work. Create preview deployments when you need to share changes with your team or test on different devices.

Supported content

Live preview renders your pages exactly as they appear when published, including:

• Text and components: All MDX content, callouts, code blocks, and other components update in real time.
• Images: Local and remote images display as you add or change them.
• Videos: Self-hosted videos using <video> tags (MP4, WebM, MOV) display inline in the preview.
• Navigation: Changes to your site navigation and configuration are reflected immediately.