mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
0f3871159a
* remove preview deployments * update configuration image * remove live preview * update media page * Revert "remove live preview" This reverts commit7f84b744b8. * Revert "remove preview deployments" This reverts commitda80ef4754. * update navigation images * Update pages.mdx * update collaborate page with new preview UI * update publish images * Update index.mdx * update live preview image
40 lines
1.4 KiB
Plaintext
40 lines
1.4 KiB
Plaintext
---
|
|
title: "Live preview"
|
|
description: "Preview your documentation site and see changes in real time as you edit."
|
|
keywords: ["preview"]
|
|
---
|
|
|
|
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 <Icon icon="play" /> play button in the toolbar to open a live preview in a new tab.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/editor/live-preview-light.png"
|
|
alt="Live preview button on the editor toolbar."
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/editor/live-preview-dark.png"
|
|
alt="Live preview button on the editor toolbar."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
<Note>
|
|
Live preview is only available for public documentation. If your documentation requires authentication, the editor displays a "Live preview unavailable" message.
|
|
</Note>
|
|
|
|
## 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.
|