Typemark Documentation

Visual mode

Write in an editor that looks like your published page, with slash commands, a floating toolbar, and editable components.

Actualizado el 19 nov 20265 min de lectura

Visual mode is where the editor opens. You edit the page with the same typography and spacing your readers see, and Typemark writes clean MDX underneath.

The top bar

Everything about the page you're on lives in one bar at the top:

ControlWhat it does
BranchShows the branch you're editing, and switches to another or creates one. See Branches in the editor.
Visual / SourceSwitches between visual and source mode
LanguageOn a site in several languages, opens this page in another one, with each AI translation's status
Undo and redoSteps back and forward through your edits (visual mode)
AvatarsShows who else has this page open
Save stateTells you whether your work is saved
PreviewOpens this page on your live site
SaveSaves right away. Appears when you have unsaved changes.
PublishPuts your saved changes live. Appears when the project uses manual deploy.

Below the bar, a single banner tells you anything that needs your attention, such as a site that's still offline, a project you can only view, or the branch you're working on.

Saving

Typemark saves three seconds after you stop typing. Press Cmd+S to save right away. The save state shows one of:

  • Saved: everything is committed to your repo
  • Saving…: a save is in progress
  • Unsaved changes: you have edits that haven't been saved yet
  • Couldn't save: the save didn't go through. Your changes are still in the editor. Try again.

After a save, the page builds in the background. You'll see Building while it runs and Build failed if something goes wrong. If you try to leave with unsaved changes, Typemark asks first.

Title and description

The page title and description sit at the top of the page, where readers see them. Click either one to edit it. Typemark stores both in the page's frontmatter and leaves your other frontmatter fields as you wrote them. To edit fields like icon, use source mode.

Slash commands

Type / to open the command menu. Keep typing to filter by name: /call finds Callout, /code finds Code block and Code group.

CommandInserts
Heading 1, 2, 3Section headings
Bullet listUnordered list
Numbered listOrdered list
Task listChecklist
Code blockCode with syntax highlighting and a language picker
BlockquoteQuote block
CalloutInfo, warning, danger, or tip box
AccordionCollapsible section
StepsNumbered step-by-step guide
TabsTabbed content
Code groupTabbed code blocks
CardCard with title, icon, and link
Card groupGrid of cards
ImageUploads an image from your computer
VideoA YouTube, Vimeo, Loom, or Wistia video, or a video file, from its link
TableThree-by-three table with a header row
DividerHorizontal rule

The AI commands sit at the bottom of the menu: Ask AI, Continue writing, Draft with AI, Improve writing, and Auto-structure. You can also press Space on an empty line, or Cmd+J anywhere, to ask AI. See AI writing.

The block handle

Hover over any block to see its handle in the left margin.

  • + adds a block below and opens the slash menu
  • Drag the grip to move the block, including into and out of components
  • Click the grip for the block menu: Turn into, Insert block above, Insert block below, Move up, Move down, Duplicate, and Delete

Press Cmd+. to open the block menu for the block your cursor is in. Deleting a block doesn't ask for confirmation. Cmd+Z brings it back.

Floating toolbar

Select text to bring up the floating toolbar:

  • Bold, italic, and strikethrough
  • Inline code
  • Link, with a field for the URL
  • Ask AI comes first when your project's plan includes AI writing

Editing components

Components render as blocks you edit in place, not as raw code:

  • Callout: pick the type from the dropdown and add an optional title.
  • Tabs and Code group: add, rename, reorder, and remove tabs from the tab bar.
  • Steps and Accordion: edit the title at the top of each block.
  • Card: pick an icon, set a title and an optional link.
  • Card group: choose the number of columns and click Add card.
  • Code block: choose a language from the picker. A Mermaid block shows the diagram under the code.
  • Video: paste a link, or click Change link to swap it. See Videos.
  • Table: select a cell to add or delete rows and columns, or delete the table.

Images get their own toolbar for size and alt text. See Images.

Pages that won't open visually

If the visual editor can't open a page safely, it opens in source mode instead, with a banner that says why. Fix the MDX there and switch back to Visual. The visual editor never saves over a page it couldn't load.

The sidebar

The sidebar has two views:

  • Navigation shows your site's tabs, groups, and pages, the way readers see them. Drag pages to reorder them or move them between groups. Hover over a group and click + to add a page. Use Add group and Add tab to grow the structure, and the … menus to rename or delete groups and tabs.
  • Files shows every file in your repo. Click an .mdx or .md file to open it.

Changes in the Navigation view save to typemark.json. See Navigation.

Working together

When teammates have the same page open, their avatars appear in the top bar. If someone saves the page while you're on it, you'll see a note saying so.

Typemark doesn't merge simultaneous edits. If you save after someone else, it stops and asks you to reload instead of overwriting their work. Reloading shows their version and drops your unsaved changes, so copy anything you want to keep first.

Read-only

Viewers and projects that are locked on the Free plan open in read-only mode. The save state shows Read-only and the banner explains why.