Live preview
Live preview renders your site as you edit, with no build step. Click the live preview button in the top bar. To edit site settings and see how they affect your content, click Site settings in the preview toolbar, then select a configuration section. This menu is unavailable if you have Open live preview in new tab enabled. To open the agent beside the preview, click Ask agent in the preview toolbar. Only editors and admins can use the agent in live previews.Live preview is only available for public sites and sites protected by Mintlify authentication.
Preview deployments
When you open a pull request from a feature branch, Mintlify builds a preview deployment: a temporary URL where your changes render exactly as they look when published. The preview rebuilds each time you save new changes to the branch. The URL format isorganization-branch-name.mintlify.site.
Preview URLs are publicly accessible by default. To restrict access to members of your Mintlify organization, enable preview authentication on the Add-ons page of your dashboard.
Which preview to use
Share an editor link
To point a teammate at a specific page on a branch, copy the URL from your browser’s address bar. Anyone with access to your Mintlify organization can open it in their own editor session.https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx
Review and merge pull requests
When a pull request is open for the current branch, the publish menu shows a review panel with the number of changed files and current review status. After a reviewer approves, click Merge and publish to merge and deploy from the editor. The editor switches you back to your deployment branch after merging.Approve from the editor
For GitHub repositories, reviewers can approve open pull requests without leaving the editor. An Approve pull request button appears in the review panel if your account has permission to review it. The status updates to Approved and Merge and publish becomes available. If you use GitLab or Bitbucket, open the pull request in your Git provider to approve it.Compare changes before merging
Click any changed file in the publish menu to open it in diff view against the published version. Visual mode shows a visual diff and source mode shows a text diff. Files that can’t display a diff, such as images or deleted files, appear in the list but aren’t clickable. Hidden pages that appear in the branch diff are openable from the publish menu, even though they don’t appear in your site navigation.Pull request titles and descriptions
If your organization requires pull requests, you can enter a title and description when you publish. If you leave either blank, the editor generates one listing the files you created, updated, moved, or deleted. To control how those are written, set PR instructions. If your branch has open comment threads, Mintlify adds a summary of them to the pull request description. See Collaborate.Review an automation run
When an automation opens a pull request, you can open the editor on the automation’s branch:- From the Automation Runs page in your dashboard, click Open in editor on a completed run.
- From a Slack notification, click the View changes link.