| title | Desktop app |
|---|---|
| description | Install the Mintlify desktop app for macOS, Windows, or Linux to use your dashboard and editor in a native window with tabs and keyboard shortcuts. |
| tag | New |
The Mintlify desktop app runs your dashboard and editor on your computer. Work in tabs or multiple windows with access to the same content and settings you access in the browser.
The desktop app updates content the same way the editor does. You can also open Markdown files from your computer to edit them or copy them into a project. To preview your whole site locally, use the CLI.
1. Download the desktop app from [mintlify.com/desktop](https://mintlify.com/desktop).
2. Open the file.
3. Drag **Mintlify** to your **Applications** folder.
You can also install from the terminal.
```bash Install the desktop app
curl -fsSL https://desktop.mintlify.com/install.sh | bash
```
The script installs to `/Applications`, or to `~/Applications` if you can't write to `/Applications`.
1. Download the desktop app from [mintlify.com/desktop](https://mintlify.com/desktop).
2. Run the installer.
Download either file from [mintlify.com/desktop](https://mintlify.com/desktop) or install the AppImage from the terminal.
```bash Install the desktop app
curl -fsSL https://desktop.mintlify.com/install.sh | bash
```
The script installs the app to `~/.local/share/mintlify-desktop`, adds a `mintlify-desktop` command to `~/.local/bin`, and adds Mintlify to your application menu.
AppImages require FUSE 2. If the desktop app doesn't start, install FUSE 2. On Ubuntu:
```bash Install FUSE 2
sudo apt install libfuse2
```
The desktop app signs you in with the Mintlify account you already use in your default browser.
- Open the desktop app. The desktop app shows a Log in to Mintlify screen.
- Click Continue in browser. Your default browser opens a Mintlify consent page that shows your account and organization.
- Click Approve. To sign in to another organization, click Use a different organization first.
- Return to the desktop app. The desktop app signs you in.
The desktop app and your browser share the same session. Signing out of one signs you out of the other.
Browser sign-in isn't available for some organizations, such as organizations that set a maximum session lifetime. If the consent page says desktop login is not available, sign in inside the desktop app instead:
- On the Log in to Mintlify screen, click Log in here instead.
- Sign in the same way you sign in to your dashboard in your browser.
Open each page you're working on in its own tab or window. Tabs and windows reopen where you left them when you restart the app.
Right-click a tab to duplicate it, copy its link, or close other tabs. Middle-click a tab to close it.
To show tabs in a sidebar instead of across the top of the window, change the tab layout in Settings.
All tabs and windows share one session. Signing out or switching organizations in one tab applies to every tab, and the app reloads your open tabs. If a different person signs in, the app clears stored data first.
Tabs only load the Mintlify dashboard and the services it uses for signing in, billing, connecting Git providers, and connecting Slack. Links to any other site open in your default browser.
Links that start with mintlify:// open in the desktop app. Share them in Slack, add them to your docs, or paste them in your browser's address bar. The app opens the page in a new tab of your current window and brings the window to the front.
To write a mintlify:// link, replace https://app.mintlify.com/ in a dashboard URL with mintlify://. For example, this link opens the same page as https://app.mintlify.com/acme/docs/editor:
mintlify://acme/docs/editor
The app ignores mintlify:// links that would leave the Mintlify dashboard.
To open mintlify:// links in your default browser instead, turn off Open Mintlify links in the app in Settings.
After you sign in to the desktop app through your browser, that browser opens dashboard pages in the app by default. When you open a dashboard link from outside the dashboard, such as from Slack or email, the browser shows a Redirecting to Mintlify Desktop… page and the page opens in the desktop app. Links you follow within the dashboard stay in your browser.
If your browser asks for permission to open Mintlify, allow it. To skip the prompt next time, choose to always allow Mintlify links.
To open a single link in your browser, click Or continue in browser on the redirect page.
To stop opening dashboard pages in the app, click Stop opening Mintlify Desktop automatically on the redirect page, or turn off Always open in desktop app in your Profile settings. Either option applies only to the current browser.
Dashboard pages open in the app this way even when Open Mintlify links in the app is off.
Open a Markdown file from your computer to view and edit it in the editor. The desktop app opens .md, .mdx, .markdown, and .txt files up to 5 MB.
To open a file, click Open File... in the File menu or press Cmd + O. The file opens in a new tab.
- Visual mode renders the file with Mintlify components such as callouts, cards, steps, and code blocks.
- Markdown mode shows the raw source. Use it for content the visual editor can't render.
Press Cmd + S or click Save to write your changes back to the file. The desktop app keeps the file's frontmatter unchanged. Saving from Visual mode can reformat some Markdown, such as list markers and spacing.
Visual mode does not apply your site's theme or load snippets and relative images. Local file tabs don't reopen when you restart the app.
You don't need to sign in to open and edit local files.
When you're signed in, you can add a local file to one of your organization's projects as a new page.
- Click Copy to project.
- Select a project.
The desktop app opens the project in the editor in a new tab and adds the file as a new page at the end of your navigation. The page title and description come from the file's frontmatter. Publish the page like any other change.
On Windows and Linux, use Ctrl instead of Cmd.
| Action | Shortcut |
|---|---|
| New tab | Cmd + T |
| New page in a new tab | Cmd + N |
| Open file | Cmd + O |
| New window | Cmd + Shift + N |
| Close tab | Cmd + W |
| Close window | Cmd + Shift + W |
| Go to tab 1-9 | Cmd + 1-9 |
| Next tab | Ctrl + Tab |
| Previous tab | Ctrl + Shift + Tab |
| Back | Cmd + [ |
| Forward | Cmd + ] |
| Reload | Cmd + R |
| Zoom in | Cmd + + |
| Zoom out | Cmd + - |
| Reset zoom | Cmd + 0 |
| Find in page | Cmd + F |
| Find next | Cmd + G |
| Find previous | Cmd + Shift + G |
| Copy page URL | Cmd + Shift + C |
| Open settings | Cmd + , |
For shortcuts inside the editor, see Keyboard shortcuts.
Open settings with Cmd + , on macOS or Ctrl + , on Windows and Linux.
- Tab layout: Show tabs across the top of the window (Horizontal) or in a sidebar (Vertical).
- Open Mintlify links in the app: Open
mintlify://links in the app. On by default. When off, these links open in your default browser. - Check for updates: Check for a new version of the app. See Updates.
- Clear all data: Sign out of every tab, close all tabs, and reset settings. The app restarts.
The settings window also shows the app version.
The app checks for updates when it starts and every four hours while it runs. When an update is available, an Update available button appears in the tab bar.
To manually check for updates, click Check for updates in Settings. You can also select Check for Updates… from the app menu. On macOS, it's under About Mintlify in the Mintlify menu. On Windows and Linux, it's at the bottom of the File menu. A dialog shows whether an update is available and lets you install it.
- macOS: Click Update in the dialog, or Update available in the tab bar, to download the update. When it finishes, click Restart to update.
- Windows and Linux: Click Update to download the new version from your browser, then install it.
```bash Remove the desktop app
rm -rf ~/.local/share/mintlify-desktop \
~/.local/bin/mintlify-desktop \
~/.local/share/applications/mintlify-desktop.desktop \
~/.local/share/icons/hicolor/512x512/apps/mintlify-desktop.png
```
If you installed the `.deb` package, remove it with your package manager.
To remove your sign-in and settings, delete `~/.config/Mintlify Electron`.