Skip to main content
The left panel has two views: Navigation and Files. Navigation shows your sidebar structure as visitors see it. Click a page to open it. Files shows the full file tree of your repository, including files that aren’t in your navigation. Click any file to open it. To switch between views, click the file icon or press Cmd + Shift + F (macOS) or Ctrl + Shift + F (Windows). Click the search icon or press Cmd + K (macOS) or Ctrl + K (Windows) to search by filename or page content.

Manage files and folders

Use the Files view to organize your content:
  • Create a folder: Click the new folder button at the top of the file tree, or right-click an existing folder and select New folder.
  • Rename a file or folder: Right-click the item and select Rename.
  • Open unlisted files: Click any file in the tree to open it, even if it isn’t included in your navigation.
Files that aren’t in your navigation remain unlisted. They exist in your repository but won’t appear in the published sidebar.

Create new pages

Add a page to navigation

  1. Click the plus button in the navigation element where you want to add a page.
  2. Click Add a page.
  3. Enter a filename. The editor adds the .mdx extension automatically.

Create an unlisted page

Unlisted pages exist in your repository but don’t appear in navigation. They’re useful for draft content, reusable snippets, or pages you plan to add to navigation later. Right-click any folder in the Files view and select New file. Enter a filename and the editor creates the page without adding it to navigation. You can add it to navigation later from the Navigation tab.

Edit content

Switch between visual and source mode using the mode toggle in the toolbar below the top bar. Click the eye icon or press Cmd + Shift + M (macOS) or Ctrl + Shift + M (Windows) to switch to visual mode. Click the code icon or press Cmd + Shift + M (macOS) or Ctrl + Shift + M (Windows) to switch to source mode. Visual mode shows a real-time preview as you type. Press / to open the component menu and insert components, images, videos, and other content. You can also drag and drop media files directly onto the page from your computer or from the navigation tree. Other shortcuts:
  • Insert a link: Select text and press Cmd + K (macOS) or Ctrl + K (Windows), or drag a page from the navigation tree into the editor to create a link with the page title.
  • Link to another page: Right-click a page in the navigation tree, click Copy link, then paste the link into your content. The editor recognizes internal links to other pages and converts them.
  • Insert media from your project: Drag an image or video from the navigation tree into the page to embed it inline. Supported formats include PNG, JPG, JPEG, GIF, WebP, SVG, MP4, and WebM.
  • Insert an emoji: Type : followed by a keyword to open the emoji picker.
  • Edit a table: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells.
Source mode gives you direct access to the MDX source. Use it for precise control over component properties and frontmatter. For a full list of components, see Components. For MDX syntax, see Format text and Format code.

Diff view

To compare your current page against the last published version, click the View diff button in the toolbar, or press Cmd + Shift + D (macOS) or Ctrl + Shift + D (Windows). In visual mode this shows a visual diff. In source mode it shows a text diff. Click Exit diff or press the shortcut again to return to editing. You can also open a diff from the publish menu. Click Publish then click any changed file in the list.

Version history

Use version history to review saved versions of the page you’re editing. Mint records a new entry when the editor saves content that differs from the latest recorded version. Saving unchanged content doesn’t create a duplicate entry. A saved page can also be empty. Each entry shows the author and relative save time. The most recent entry is marked Latest. To open version history:
  1. Open a documentation page in the editor. Version history isn’t available for docs.json.
  2. Click More options in the top-right corner.
  3. Select Version history.
The drawer shows versions for the current page on the current branch. Click Show more versions to load older entries. Older versions include a Restore action when you have permission to edit the page. Click Restore, then confirm to replace the current page content with that saved version. This overwrites unsaved changes. Restore applies the selected snapshot to the current page in the active site, deployment, and branch. It doesn’t create a new page or merely preview the saved content. To compare an older saved version with the current page, click its row. The editor opens diff view with the saved version as the baseline and current page content as the comparison. The row shows Viewing while active. Click the active row again to exit comparison and return to editing. Restore isn’t available on blocked deploy branches or the Latest version.

Block actions

In visual mode, hover over any block to reveal a drag handle on the left. Click the handle to open a context menu with actions for that block:
  • Turn into: Convert the block to a different type: text, headings, blockquote, or list.
  • Duplicate: Insert a copy of the block immediately after it.
  • Delete: Remove the block.
The block actions menu in visual mode.

Table of contents

In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Click any heading to scroll to that section.

Code block options

When editing a code block in visual mode, you can:
  • Highlight or focus lines: Select text within the code block, then use the toolbar that appears to mark lines as highlighted or focused. Highlighting visually emphasizes lines. Focusing lines dims everything else.
  • Mark diff lines: Select lines and use the toolbar to mark them as additions (+) or removals (-).
  • Wrap: Toggle line wrapping in the code block settings.
  • Expandable: Make the code block collapsible so readers can expand it on demand.

Manage pages

  • Move: Drag and drop pages to reorder them in navigation.
  • Rename: Right-click a page and select Rename.
  • Duplicate: Right-click a page and select Duplicate.
  • Delete: Right-click a page and select Delete. The editor removes the page from navigation automatically.

Pages deleted via Git

If a teammate deletes a page through Git while you have it open, the editor enters read-only mode and shows a banner. The editor preserves your content so you can copy it before navigating away.

Configure pages

Hover over a page and click the gear icon, or right-click and select Settings, to configure:
  • Title, Slug, and Sidebar title: Control how the page appears in navigation and its URL.
  • Description and Keywords: Improve search and SEO.
  • Layout: Choose from standard, wide, centered, or custom.
For details on each setting, see Pages.

Add media

Images and videos

Type /image to upload a new image or select an existing one from your repository. Type /video to upload or select a video. You can also drag and drop files from your computer directly onto a page. In visual mode, the file inserts inline. In source mode, the editor inserts the file path at your cursor position. Images save to your images/ folder and videos to videos/. To reuse media that already lives in your project, drag an image or video file from the navigation tree onto the page. The editor embeds the asset inline.

Light and dark image variants

After inserting an image in visual mode, hover over it to reveal the image toolbar. Use Light/dark variants to upload separate images for light and dark mode.

Embed external media

Type /embed and paste a YouTube, Loom, or Vimeo URL. The editor detects the provider and generates the iframe. Searching the slash menu for youtube, yt, loom, or vimeo also surfaces the Embed command. For other embeds, type /embed and toggle Manual embed to write custom HTML. For more on formatting images and using the Frame component, see Images and embeds.