Typemark Documentation

Preview deployments

Every pull request into your deployment branch gets its own preview of your site, linked from the pull request. Available on Pro and Enterprise.

Updated Nov 19, 20263 min read

Open a pull request into your deployment branch and Typemark builds the site it would publish, at an address of its own, and links it from the pull request. Reviewers read the change the way readers will see it, before it's merged, and your live site doesn't change. Preview deployments are on Pro and Enterprise, follow the project owner's plan, and work on projects connected to GitHub.

How it works

  1. Open a pull request

    Push a branch to your repository and open a pull request into the deployment branch.

  2. Typemark comments with the link

    Typemark builds the pull request's branch and adds a comment to the pull request with the preview's address.

  3. Push more changes

    Every push to the pull request builds the preview again, at the same address. Typemark updates its comment rather than adding a new one.

  4. Merge or close

    Merging publishes the change to your live site as usual. Either way, the preview is removed.

The preview address

A preview's address is your project's address with --pr- and the pull request's number added:

https://acme-docs--pr-12.typemark.dev

Previews are always on typemark.dev, also when your site has a custom domain.

The pull request comment

Typemark keeps one comment on each pull request, and edits it as things change:

Typemark preview of 4f2c9e1

Ready: https://acme-docs--pr-12.typemark.dev

The preview follows every push to this pull request, isn't indexed by search engines, and is removed when the pull request is closed.

If a build fails, the comment shows the error, and the last preview that built stays up. If someone deletes the comment, the next build posts a new one.

What's in a preview

A preview is your site as the pull request's branch has it: its pages, navigation, typemark.json, images, custom CSS, and translations, with /fr/ addresses and the language picker. Every page is published at once, even if you publish manually.

A banner across the top says which pull request it's a preview of, with links to the pull request and to your live site, so nobody mistakes it for the real thing.

Only for reviewers

Previews are for reading a change, not for readers or AI tools:

  • Search engines are told not to index them, and their robots.txt blocks crawlers. There's no sitemap.
  • There's no llms.txt, llms-full.txt, Markdown version of pages, or MCP server.
  • There's no Ask AI, page actions menu, or feedback widget. Search works, over the preview's pages.
  • Page views aren't counted in Analytics, and integrations such as Google Analytics don't load.
  • AI translations don't run on previews.

Anyone with the address can open a preview, so treat it as you would your live site.

Previews never show more than your live site

What keeps readers out of your live site keeps them out of its previews too. If your site has a password, each preview asks for it, once per preview address. While your site is offline, its previews are built but show the "coming soon" page, and the comment says previews are served once the site is live.

When previews are removed

A preview is removed, and the comment says why, when:

  • the pull request is merged or closed;
  • the pull request's base changes to a branch other than the deployment branch;
  • nobody has pushed to it for 14 days. Push again and it comes back;
  • the project is disconnected from GitHub.

Pull requests without a preview

  • Pull requests from forks. A fork's author could publish anything at an address under your project's name without being on your team, so forks aren't built. To preview one, push its branch to your repository and open the pull request from there.
  • Pull requests into another branch. Only pull requests into the deployment branch get a preview.
  • Projects whose owner isn't on Pro or Enterprise.

Your project's slug and --pr-12 together have to fit in 63 characters, the longest name an address can have. With a slug longer than about 55 characters, the preview builds but has no address, and the comment says so.

Plans

Preview deployments follow the project owner's plan. If the owner moves to Free, previews stop being served and new pull requests aren't built. Upgrade again and the previews that were there come back.

Branches in the editor

Branches you create in the Typemark editor get a preview too, at an address made from the branch name, such as acme-docs--rewrite-quickstart.typemark.dev. A pull request opened from one uses that preview. See Branches in the editor.

My pull request has no comment

Check that the pull request is into the deployment branch, from a branch of the same repository rather than a fork, and that the project owner is on Pro or Enterprise. Typemark needs access to pull requests to build previews and comment on them: if GitHub asks an owner of your account or organization to accept new permissions for the Typemark app, accept them.