mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
ce3e99d196
* docs: document live preview site settings * docs: refine live preview translations and metadata * docs: document live preview agent panel * docs: refine live preview copy * 💅 * localize --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
54 lines
2.1 KiB
Plaintext
54 lines
2.1 KiB
Plaintext
---
|
|
title: "Live preview"
|
|
description: "Preview your site in real time as you edit, with continuous updates that render content, navigation, and configuration changes instantly."
|
|
keywords: ["editor", "preview", "live preview"]
|
|
---
|
|
|
|
Preview your site while you edit. Live previews render pages exactly as they look when published, and update as you make changes to content, navigation, and configuration.
|
|
|
|
## Open live preview
|
|
|
|
Click the <Icon icon="play" /> live preview button in the top bar.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/editor/live-preview-light.png"
|
|
alt="The live preview button in the toolbar."
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/editor/live-preview-dark.png"
|
|
alt="The live preview button in the toolbar."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
## Edit site settings in live preview
|
|
|
|
Edit your site settings in the live preview to see how they affect the rendered content.
|
|
|
|
1. Open the live preview in the editor.
|
|
2. Click **Site settings** in the preview toolbar.
|
|
3. Select a configuration section and edit the settings.
|
|
|
|
If you set the live preview to open in a new tab, the preview site settings menu is unavailable. Disable **Open live preview in new tab** in [editor settings](/editor/settings) to use the site settings menu.
|
|
|
|
## Ask the agent in live preview
|
|
|
|
Click **Ask agent** in the preview toolbar to open the [editor agent](/editor/agent) beside the live preview. Only editors and admins can use the agent in live previews.
|
|
|
|
<Note>
|
|
Live preview works for public sites and sites protected by Mintlify authentication.
|
|
</Note>
|
|
|
|
## Live preview versus preview deployments
|
|
|
|
| | Live preview | Preview deployment |
|
|
|---|---|---|
|
|
| **Speed** | Instant | Requires a build |
|
|
| **Access** | Local URL | Shareable URL |
|
|
| **Use when** | Reviewing changes while editing | Sharing with your team for review |
|
|
| **Availability** | While the editor is open | As long as the branch exists |
|
|
|
|
Use live preview for immediate feedback while editing. When you need to share changes with your team or test on a different device, use a [preview deployment](/editor/branching-and-publishing#preview-your-changes).
|