mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
d77db08984
* Update editor/live-preview.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update editor/live-preview.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Apply suggestion from @ethanpalm * Apply suggestions from code review * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
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" /> 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.
|