Typemark Documentation

Private docs

Protect your docs site with a password on Pro, or let in only the people you choose on Enterprise.

Updated Nov 19, 20263 min read

Make your docs site private so only people with the password can read it. Use it for internal docs, partner portals, or docs for a product that hasn't launched yet. A password is on Pro and Enterprise, and letting in only the people you choose is on Enterprise. Both follow the project owner's plan.

Make your site private

  1. Go to Settings > Who can read.
  2. Choose People with the password.
  3. Type a password of at least 8 characters and click Protect with password.

Your site asks for the password straight away, on your custom domain and on your-project.typemark.dev, and on its previews.

The password is kept by Typemark, not in your repository or typemark.json, so it never ends up on GitHub and a push can't make your site public.

What readers see

Readers see a page with your site's name, logo, and colour, and a password field. Once they type the password, they stay signed in on that browser for 30 days.

They sign in once per address. Signing in on your custom domain doesn't sign them in on your-project.typemark.dev.

Everyone types the password, members of your project included.

What stays private

Everything on the site needs the password:

  • pages, and their Markdown versions
  • search and AI search
  • llms.txt and llms-full.txt
  • images and other files from your repository
  • "Was this page helpful?" feedback

Only your logo and favicon load without it, so the password page can show them.

A private site:

  • tells search engines not to index it, and isn't listed in any sitemap
  • has no MCP server, and its pages don't show the page actions menu or the "Use these docs with AI" card, since AI tools can't sign in
  • is never stored by a browser or proxy cache

Let in only the people you choose

On Enterprise, you can skip the shared password and let people in by who they are. Choose People you choose under Who can read.

  • Email domains: anyone with an email at these domains, such as partner.io, can read. They type their work email and we send them a sign-in link. The link works once, for 15 minutes.
  • Let your single sign-on in: people on your single sign-on domains sign in through your identity provider instead of waiting for an email. This option shows once SSO is set up and on.

Readers stay signed in for 30 days, as with a password. Changing the domains or the SSO setting signs everyone out.

The sign-in page answers the same whether or not an email can read, so it never tells strangers who can. We send at most five links an hour to the same address.

Reading the docs through SSO doesn't sign someone in to Typemark itself. Readers don't need a Typemark account.

Change the password

Type a new password under Who can read and click Change password. Everyone who signed in with the old password has to sign in again.

Make your site public again

Choose Anyone and click Make public. Typemark forgets the password, so making the site private again later needs a new one.

If you leave Pro or Enterprise

Typemark never makes your site public for you. You can make it public at any time, on any plan.

  • A password-protected site stays private and keeps its password. You need Pro or Enterprise again to change the password.
  • A site for people you choose stays limited to them, and email sign-in links keep working. Signing in through your single sign-on stops, since SSO is on Enterprise. On Pro you can switch the site to a password instead.