mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
110 lines
4.3 KiB
Plaintext
110 lines
4.3 KiB
Plaintext
---
|
|
title: "Create and edit pages"
|
|
description: "Create, edit, and organize documentation pages in the web editor."
|
|
keywords: ["editor","content","pages","files"]
|
|
---
|
|
|
|
## Navigate files
|
|
|
|
Browse your documentation pages in the **Navigation** tab of the left panel.
|
|
|
|
- Click navigation elements to expand or collapse them.
|
|
- Click pages to open them in the editor.
|
|
- Click the search icon or press <kbd>Cmd</kbd> + <kbd>P</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>P</kbd> (Windows) to search for files by filename. Search matches exact filenames, so use hyphens between words (for example, `get-agent-job` instead of `get agent job`).
|
|
|
|
## Create new pages
|
|
|
|
1. Click the **\+** button in the navigation element where you want to add a page.
|
|
1. Click **Add a page**.
|
|
1. Enter a filename. 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.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/editor/mode-toggle-light.png"
|
|
alt="Mode toggle in the toolbar."
|
|
className="block dark:hidden"
|
|
/>
|
|
|
|
<img
|
|
src="/images/editor/mode-toggle-dark.png"
|
|
alt="Mode toggle in the toolbar."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
### Visual mode
|
|
|
|
Edit content with real-time previews that show how the content looks when 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 <kbd>/</kbd> to open the component menu and select components.
|
|
- **Add images**: Use the image component from the <kbd>/</kbd> menu.
|
|
- **Insert links**: Select text and press <kbd>Cmd</kbd> + <kbd>K</kbd>.
|
|
|
|
See [Components](/components) 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.
|
|
- **Component properties**: Set component properties and configurations.
|
|
- **Frontmatter**: Edit page metadata at the top of the file.
|
|
|
|
See [Format text](/create/text) and [Format code](/create/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.
|
|
|
|
1. Right-click a file.
|
|
2. Click **Configure**.
|
|
|
|
### 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 pages
|
|
|
|
### Move pages
|
|
|
|
Drag and drop pages to reorder them in your navigation or move files between folders in the file tree.
|
|
|
|
### Duplicate pages
|
|
|
|
Right-click a page and select **Duplicate**.
|
|
|
|
### Delete pages
|
|
|
|
Right-click a page and select **Delete**. Deleting a page removes it from your navigation automatically.
|
|
|
|
### Hide pages
|
|
|
|
To remove a page from navigation without deleting the file, right-click the page and click **Hide Page**. The file remains in your repository and you can unhide the page by adding it to your `docs.json` navigation. |