Typemark Documentation

AI writing

Ask AI to write, rewrite, review and link your pages, or change every page at once, and review each change before it's yours.

Updated Nov 19, 20266 min read

AI is part of the visual editor. Ask it to rewrite a sentence, continue a paragraph, review a page, add links to your other pages, or rename something across your whole site. Everything it suggests appears in the page for you to accept or reject; nothing changes until you do. It comes with Pro and Enterprise, with no credits to buy.

Ask AI

Ask AI works on the text your cursor is in. Open it any of these ways:

  • Press Cmd+J in a paragraph, or with text selected.
  • Select text and click Ask AI in the floating toolbar.
  • Press Space on an empty line.
  • Type / and choose Ask AI.

Type what you want ("make this friendlier", "turn this into a table", "add an example in Python") and press Enter, or pick a suggestion:

With textOn an empty line
Improve writing, Fix spelling and grammarContinue writing
Make shorter, Make longer, Simplify languageWrite an introduction
Change tone: friendlier, more professional, more direct, more confidentAdd a code example, a troubleshooting section, an FAQ, or next steps
Turn into: steps, a bulleted list, a table, a callout, or componentsSummarize the page
Translate into another language, Add an exampleAnything you type

Use ↑ and ↓ to move through the suggestions and → to open one with more choices.

Review a suggestion

AI writes into the page behind a cursor, on a light highlight, so you see the result as it will look: headings, lists and callouts appear as real blocks. When it's done:

  • A small rewrite reads as one passage: removed words are struck through and new words are highlighted.
  • A bigger change shows your original text struck through above the new version.
  • Accept (Cmd+Enter) keeps it. Cmd+Z brings your original text back.
  • Discard (Esc) leaves the page as it was.
  • Try again asks for another version.
  • Tell AI what to change refines the suggestion: "shorter", "keep the second sentence", "more formal".

Your page is saved as it was until you accept, so a suggestion you never accept is never published.

New text goes after the paragraph your cursor is in, never in the middle of a word. On an empty line, it takes that line's place.

The assistant

Click Assistant in the top bar, or press Cmd+J when you're not typing in the page. On a wide screen it opens by itself until you close it; on a phone it opens full screen. The assistant knows the page you're on and the rest of your docs. Ask it questions, or tell it what to change:

  • Review this page: what's unclear, wrong, missing or out of order, with fixes
  • Suggest links to other pages: adds links to your own pages, with their real paths
  • Make it easier to scan, Add a troubleshooting section, Check it against the other pages
  • Anything else: "is this right for Windows?", "add a note that sandbox keys work too"

Its changes appear in the page as suggestions, each with a reason. A bar at the bottom of the page steps through them: Accept or Reject each one, or Accept all at once (one Cmd+Z undoes them all). Notes it can't fix itself, like a fact it can't check, are marked with a dotted line beside the block they're about.

If you select text before asking, the assistant focuses on it.

Change every page

Switch the assistant to All pages and describe the change: "Rename Acme Platform to Acme Cloud", "Say sign in, not log in". The assistant finds the pages it affects and proposes the changes page by page, then says how many changes it proposed and on which pages. Pages that needed no change are folded into one line.

Click Review changes, or a page in the list, to see each change with the text around it. A change applies everywhere its text appears on the page, and the review says when that's more than one place. Reject the changes you don't want, or untick a page to leave it all out, and click Apply. The changes you kept go in as one commit, and nothing changes before that. Your choices are kept if you close the review, and the proposal stays in the assistant when you open another page. Open page opens a page in a new tab, so you can check it without leaving the review. If you don't want any of it, click Discard.

If the page you have open has edits you haven't saved, they're saved first. The changes go into each page as it is when you apply them, so edits made after the assistant read a page are kept. A change whose text is no longer there is left out, and the assistant tells you.

Changed your mind? Undo puts the pages back as they were before you applied, as a new commit. A page someone edited since is left as it is.

The assistant goes through up to 12 pages at a time. When more pages match, click Continue to have it go through the next ones.

What readers couldn't find

The assistant lists the questions readers searched for or asked Ask AI about on your site in the last 30 days that your docs didn't answer. Click one to have the assistant add the answer to the page, or tell you which page it belongs on.

From the overview

Your project's overview has a box to ask AI for a change across your docs, with suggestions such as answering the questions readers couldn't find, finding pages that contradict each other, and suggesting links between pages. It opens the editor with the assistant set to All pages and your request filled in. Nothing runs until you send it.

Write the description

Click Write with AI next to the description under the title, or Rewrite with AI when there is one. AI reads the page and writes one sentence, which search engines and AI assistants show under the title.

Find and run anything with Cmd+K

In the editor, Cmd+K opens pages, runs commands (open the assistant, review this page, write the description, switch to Source, preview, publish) and asks AI. Type a page's name to open it. Type a question and press Enter, or Cmd+Enter at any time, to ask the assistant.

Tell AI how you write

In Settings > AI writing, write instructions that every AI request in the editor follows: the voice, the product's exact name, words to use and avoid, British or American spelling. They're saved in typemark.json as ai.instructions, up to 2,000 characters:

{
  "ai": {
    "instructions": "Write in British English, in the second person. The product is \"Acme Pay\", never \"AcmePay\"."
  }
}

AI also reads the pages most related to what you're asking about, so it matches your tone and uses your terms. AI translations follow the same instructions for tone.

Who can use it

AI writing follows the project owner's plan:

  • If the owner is on Pro or Enterprise, everyone with the editor or owner role on that project can use it, even if their own account is on Free.
  • If the owner is on Free, the AI commands still appear with a Pro badge. Clicking one opens the Billing page.
  • Viewers can't use AI writing, since they can't change pages.

See Billing for plans and Team members for roles.

Fair use

There are no credits to track. To keep the service fast for everyone, each person has a cap on requests per minute and per day, plus a monthly allowance. A change across all pages counts as several requests. If you reach a limit, the editor tells you when it resets. The daily cap resets at midnight UTC and the monthly allowance on the 1st.

Your content

Typemark sends the text you're working on, the page, and excerpts from related pages of your project to its AI provider. It asks the provider to route requests only to model providers that don't store or train on your data.

What readers search for on your site is kept for 90 days to show you what they couldn't find, without their IP address or anything else about who they are.