Branches in the editor
Work on a branch in the Typemark editor, preview it, and merge it when it's ready, without touching your live site. Available on Pro and Enterprise.
Updated Nov 19, 20263 min read
Make a branch in the editor for changes readers shouldn't see half-done: a rewrite, a new section, a new structure. Saves on a branch stay on that branch, it gets its own preview, and your live site only changes when the branch is merged. Branches are on Pro and Enterprise, follow the project owner's plan, and work both for projects Typemark hosts and for projects connected to GitHub.
Create a branch
Open the branch menu
The editor's top bar shows the branch you're on, such as
main. Click it.Create the branch
Choose Create branch…, enter a name such as
rewrite-quickstart, and click Create branch. It starts from the latest version of your deployment branch.Edit
The editor reloads on the new branch. A strip under the top bar says which branch you're editing.
A branch name follows Git's rules for branch names, and can't be the deployment branch or a branch the project already has.
To switch, open the same menu and pick a branch. Your deployment branch is the one marked (live). Typemark remembers which branch you're on for each project.
What happens on a branch
- Saves go to the branch only. Your live site, its pages, and its publish history don't change.
- Everything in the editor works on the branch: creating and reordering pages, uploading images, and AI edits across pages.
- A page saves to the branch it was opened on. A tab you left open before switching branches still saves to its own branch.
- Who's editing and build status are per branch, so you only see the people on the same branch.
- Settings change the live site. Settings, custom code, and the GitHub connection always apply to the deployment branch, wherever the editor is.
- On a project connected to GitHub, the branch is pushed to GitHub as a branch of the same name. Commits someone pushes to that branch on GitHub are picked up the next time its preview builds.
- AI translations don't run on branches. A branch starts with the live site's translations, and the language switcher shows no AI status or Re-translate there.
Preview the branch
Click Preview in the strip under the top bar to open the branch's own preview, at an address made from the branch name:
https://acme-docs--rewrite-quickstart.typemark.dev
It works like a pull request preview: a banner says which branch it shows, search engines don't index it, and AI tools can't read it. Unlike pull request previews, a branch's preview stays until the branch is deleted, however long it goes without changes. The Preview button in the top bar still opens the page on your live site.
Get your changes live
Click Open pull request in the strip. Typemark pushes the branch and opens a pull request into your deployment branch, titled "Docs changes from" followed by the branch name. The strip then shows View pull request.
Review and merge it on GitHub. Merging publishes the change, like any push to the deployment branch. The pull request uses the branch's preview, which follows every save. The branch stays in the editor after the pull request closes, so delete it when you're done.
Delete a branch
Click Delete branch in the strip and confirm. The branch's edits, its preview, and its pages in Typemark are deleted. Changes already merged into the deployment branch stay, and on a connected project the branch on GitHub stays too.
Who can do what
| Action | Who |
|---|---|
| Switch branches and read them | Everyone on the project |
| Create a branch, save on it, open a pull request | Editors and the owner |
| Merge a branch, on a project Typemark hosts | The owner |
| Delete a branch | The owner, or whoever created it |
See Team members for roles.
Plans
Branches follow the project owner's plan. On Free, the branch button in the top bar shows a Pro badge and opens the Billing page. If the owner moves to Free, the editor goes back to the deployment branch and branches can't be changed, but they're kept: upgrade again and they're all there.
A branch that's open in the editor can't become your site's deployment branch. Delete it in the editor first.