Publish changes
Publish changes from the editor to your live site. Branches and protection rules determine what happens when you publish.
Your changes save automatically as you edit, but they only reach your live site when you publish them. What happens when you publish depends on which branch you work on and whether that branch has branch protections.
If there is no Publish button in your editor toolbar, your deployment has auto publish turned on and your edits go live automatically.
If there is no branch selector, show the branch selector.
If you only see your own changes in the Publish menu, turn on granular publishing to see everyone’s changes.
Pending changes
On your deployment branch, the editor tracks the following as pending changes until you publish them:
- Content edits in pages
- New or deleted pages
- Navigation structure changes
- Media uploads
- Configuration updates
Click Publish in the toolbar to see your pending changes. Click any changed file to compare it against the published version.
What happens when you publish
| Branch type | Branch protection | Available actions |
|---|---|---|
| Deployment branch | None | Publish directly to your live site |
| Deployment branch | Pull requests required | Create branch to move your work to a new branch |
| Feature branch | None | Request review, then Merge and publish |
| Feature branch | Protected | Create branch to keep editing on a new branch |
- Publish: Commits your pending changes to your deployment branch and deploys them to your live site.
- Request review: Marks the branch’s pull request ready for review.
- Merge and publish: Merges the pull request into your deployment branch and deploys it. Available once the pull request is ready or approved, depending on your repository’s review requirements.
- Create branch: Creates a new feature branch when you can’t publish to the current branch.
Only one publish can happen at a time per branch. If a teammate is publishing to the same branch, wait for their publish to complete, then try again.
Your live site updates after Mintlify builds and deploys your changes. This typically takes 30 seconds to a few minutes. Check the deployment status on your dashboard.
Invalid MDX blocks publishing
If any page on your branch has invalid MDX, the editor disables the Publish and Request review buttons until you fix it. Hover over Publish to see how many pages have errors, then open each page in source mode to see and fix the error. See Publish button disabled because of invalid MDX for details.
Publish specific changes
When several people have pending changes on your deployment branch, the Granular publishing setting controls which changes the Publish menu shows.
Granular publishing off (default): The Publish menu shows only your changes. That includes files you edited, files that you and teammates both edited, and files with no recorded author. Publish and Discard all apply only to those changes. If teammates have other pending changes, a notice says that their changes are hidden.
Granular publishing on: The Publish menu splits pending changes into Your changes and Modified by others. Your changes start selected, and others’ changes start unselected. Use the checkboxes to choose which changes to publish. Each section has its own Discard button.
A contributors icon marks files that someone other than you edited. Hover over it to see who edited the file.
- Granular publishing only applies on a deployment branch without branch protections. On feature branches, publishing includes every pending change.
- Deleting a folder deletes every page inside it. Those deletions publish together. You can’t partially delete a folder.
- Some changes depend on each other, like a page and its navigation entry. If your selection leaves out a change that a selected change depends on, the publish fails with an error. Adjust your selection to include the dependency, then publish again.
Work on a branch
Edit directly on your deployment branch if you don’t use a review workflow. Create a branch if each change goes through review before it reaches your live site.
To create a branch:
- Click the branch name in the editor toolbar. On your deployment branch, the name has a Live badge.
- Optionally, type a title for your branch in Find a branch.
- Click New branch.
If you don’t enter a title, the editor names the branch after the current date. If you have pending changes when you create a branch, the editor asks whether to Bring them to this branch or Leave them behind. Your original branch keeps its pending changes either way.
Edits on a branch you created in the editor commit to the branch automatically, about 15 seconds after you stop editing. The first commit opens a pull request against your deployment branch. The pull request opens as a draft if Create draft pull requests by default is on.
When your changes are ready, click Publish, then click Request review. After your pull request meets your repository’s review requirements, click Merge and publish. The editor merges the pull request and switches you back to your deployment branch.
Manage branches
The branch menu lists your deployment branch and branches with open pull requests, including pull requests opened outside the editor. Each branch shows its pull request status. To find a merged or closed branch, search for it by name.
To rename or delete a branch, hover over it in the branch menu and click Rename branch or Delete branch. Deleting a branch permanently removes it from your repository, along with any unpublished changes on it.
Show the branch selector
If your deployment branch has no branch protections, the editor hides the branch selector while you work on the deployment branch. To show it, click More options in the top bar, then turn on Branches. This preference applies only to you.
The branch selector always appears when your deployment branch has branch protections or when you work on a feature branch.
Resolve conflicts
When someone pushes to your repository from outside the editor, the editor merges their changes into the pages you have open. A notification tells you how many updates were applied.
If a remote change and your edit affect the same part of a page, the editor keeps both versions and highlights them. Review the highlighted content, keep the version you want, and delete the other.
Commit signing
Sign commits with your GitHub account by authorizing it in your account settings. Without authorization, the Mintlify GitHub App signs commits made in the editor.
Auto publish
If your deployment has auto publish turned on, the editor commits to your deployment branch shortly after you stop typing. The branch selector and Publish button are hidden. There is no pending state and no review step.