​

Create and edit pages

Create, edit, and organize documentation pages in the web editor.

To get started, simply go to Dashboard → Documentation and click the + sign to add a page or a folder and start writing.

​

Navigate files

Browse your documentation files in the Navigation tab of the left panel.

• Click navigation items to expand or collapse them.
• Click files to open them in the editor.
• Click the search icon or press Cmd + P (macOS) or Ctrl + P (Windows) to search for files by name.

​

Create new pages

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

​

Edit content

Switch between visual and Markdown mode with the toggle in the toolbar. The web editor saves your changes when switching modes.

​

Visual mode

Edit content with real-time previews that show how the content looks when it is published.

• Add text: Type in the editor to see how the text appears when published.
• Format text: Use the toolbar to bold, italicize, or apply other formatting to text.
• Add components: Press / to open the component menu and select components.
• Add images: Use the image component from the / menu.
• Insert links: Select text and press Cmd + K.

See Components documentation for the complete list of available components.

​

Markdown mode

Edit the MDX source code.

• Direct MDX editing: Write MDX and Markdown syntax for precise control over content.
• Syntax highlighting: Code is highlighted for readability.
• Component properties: Set component properties and configurations.
• Frontmatter: Edit page metadata at the top of the file.

See Format text and Format code for more information on MDX syntax.

​

Configure pages

Configure page settings to control how pages appear in navigation, search results, and your site layout. Right-click a file and select Configure to open the page configuration sheet.

​

Customize navigation appearance

Control how the page appears in your site’s navigation sidebar.

• Title: Set the main heading. Appears in navigation, browser tabs, and search results.
• Sidebar title: Display shorter text in navigation when the full title is too long for the sidebar.
• Icon: Add a visual marker next to the page to help users identify it quickly.
• External URL: Link to an external site instead of a page. Use this to add external resources to your navigation.

​

Optimize for search and sharing

Help users find your page and improve how it appears when shared.

• Description: Write a brief summary. Appears in search results and SEO meta tags.
• Keywords: Add relevant search terms to help users discover this page.
• OG Image URL: Set a custom preview image for social media shares and link previews.

​

Control page layout

Choose how the page displays to match your content needs.

• Standard layout (default): Default page with sidebar navigation and table of contents.
• Full-width layout (wide): Hides table of contents to allow wider layouts for tables, diagrams, or other content.
• Centered layout (center): Hides sidebar and table of contents for better readability of text-heavy pages like changelogs.
• Custom width (custom): Minimal layout with only the top navbar for landing pages or other unique layouts.

​

Manage files

To move files in your navigation, drag and drop them to your desired location.

To duplicate or delete files, right-click the file and select the desired action.

---