Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions editor/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,27 @@ The editor loads by default when you open your [dashboard](https://app.mintlify.
</Frame>

* **Top bar**: Click <Icon icon="panel-left" /> **Collapse sidebar** to hide your pages, and **Ask agent** to open the agent beside your page. On the **Site** tab, the top bar also has the branch selector, **Preview**, and **Publish**. On the **Workspace** tab, it has **Share**. Click <Icon icon="ellipsis" /> **More options** for page actions like **Page settings**, **Comments**, **Version history**, **Duplicate**, and **Move to**.
* **Sidebar**: Use the sidebar to select pages to edit, create new pages, manage your site structure, and move around the dashboard. Press <kbd>Cmd</kbd> + <kbd>\\</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>\\</kbd> (Windows) to hide or show your pages. Press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows) to search your pages and dashboard.
* **Dashboard icons**: Switch projects from the menu at the top. Click **Home** to return to the editor from anywhere in the dashboard, **Agent** to open a full-page [agent](/editor/agent) chat, or **Search** to search your pages and dashboard. Below those, open **Activity**, **Analytics**, **Automations**, and **Settings**. At the bottom, click <Icon icon="circle-help" /> **Get help** for documentation, support, and product updates, or click your avatar to open your profile menu.
* **Sidebar**: Use the sidebar to select pages to edit, create new pages, manage your site structure, and move around the dashboard. Press <kbd>Cmd</kbd> + <kbd>\\</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>\\</kbd> (Windows) to hide or show your pages. Press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows) to [search the dashboard](#search-the-dashboard).
* **Dashboard icons**: Switch projects from the menu at the top. Click **Home** to return to the editor from anywhere in the dashboard, **Agent** to open a full-page [agent](/editor/agent) chat, or **Search** to search your pages, settings, and automations. Below those, open **Activity**, **Analytics**, **Automations**, and **Settings**. At the bottom, click <Icon icon="circle-help" /> **Get help** for documentation, support, and product updates, or click your avatar to open your profile menu.
* **Workspace**: Pages that aren't part of your Git repository or published site. **Personal** contains your private drafts, **Teamspace** contains pages shared with your whole organization, and **Shared with me** contains pages teammates shared with you directly.
* **Site**: Your repository and published site. **Navigation** contains the pages in your site navigation. **Files** lists the files in your repository that aren't in your navigation.

## Search the dashboard

Press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows), or click **Search** in the sidebar, to search the dashboard. In visual mode, deselect any text first, because <kbd>Cmd</kbd> + <kbd>K</kbd> adds a link to selected text.

Search finds:

* Your pages.
* Settings pages.
* `docs.json` sections, which open in the editor.
* Analytics and activity sections.
* Automations by name.

Search also runs actions, such as inviting members, creating an automation, opening or closing the agent, showing or hiding the sidebar, switching between light and dark themes, contacting support, and opening the list of keyboard shortcuts. Some actions, like inviting members, appear only if your [role](/dashboard/roles) allows them.

Before you type, search suggests results for the page you're on. For example, on a settings page it suggests sections of that page, and in the editor it suggests site configuration sections.

## Visual and source mode

**Visual mode** renders your page as you type. Press <kbd>/</kbd> to open the component menu and insert components.
Expand Down
4 changes: 2 additions & 2 deletions editor/keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@

| Command | macOS | Windows |
| :--- | :--- | :--- |
| **Search pages and dashboard** | <kbd>Cmd</kbd> + <kbd>K</kbd> | <kbd>Ctrl</kbd> + <kbd>K</kbd> |
| **[Search the dashboard](/editor#search-the-dashboard)** | <kbd>Cmd</kbd> + <kbd>K</kbd> | <kbd>Ctrl</kbd> + <kbd>K</kbd> |
| **Open or close the agent** | <kbd>Cmd</kbd> + <kbd>J</kbd> | <kbd>Ctrl</kbd> + <kbd>J</kbd> |
| **Switch between visual and source mode** | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> |
| **Move current page** | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> |
| **Show or hide the sidebar** | <kbd>Ctrl</kbd> + <kbd>\\</kbd> | <kbd>Ctrl</kbd> + <kbd>\\</kbd> |
| **Undo the last sidebar action** (while the undo toast is visible) | <kbd>Cmd</kbd> + <kbd>Z</kbd> | <kbd>Ctrl</kbd> + <kbd>Z</kbd> |
| **Exit diff or version comparison** | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>D</kbd> | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>D</kbd> |
| **Apply `docs.json` changes** (while `docs.json` has unapplied changes) | <kbd>Cmd</kbd> + <kbd>S</kbd> | <kbd>Ctrl</kbd> + <kbd>S</kbd> |

Check warning on line 29 in editor/keyboard-shortcuts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/keyboard-shortcuts.mdx#L29

Did you really mean 'unapplied'?

## Visual mode

Expand Down Expand Up @@ -102,7 +102,7 @@

| Command | macOS | Windows |
| :--- | :--- | :--- |
| **Search pages and dashboard** | <kbd>Cmd</kbd> + <kbd>K</kbd> | <kbd>Ctrl</kbd> + <kbd>K</kbd> |
| **[Search the dashboard](/editor#search-the-dashboard)** | <kbd>Cmd</kbd> + <kbd>K</kbd> | <kbd>Ctrl</kbd> + <kbd>K</kbd> |
| **Find** | <kbd>Cmd</kbd> + <kbd>F</kbd> | <kbd>Ctrl</kbd> + <kbd>F</kbd> |
| **Show details at cursor** | <kbd>Cmd</kbd> + <kbd>.</kbd> | <kbd>Ctrl</kbd> + <kbd>.</kbd> |

Expand Down
Loading