Passer au contenu principal
L’application de bureau est en bêta et peut évoluer.
L’application de bureau Mintlify exécute votre Dashboard et l’éditeur sur votre ordinateur. Travaillez dans des onglets ou plusieurs fenêtres avec accès au même contenu et aux mêmes paramètres que dans le navigateur. L’application de bureau met à jour le contenu de la même manière que l’éditeur. Vous pouvez aussi ouvrir des fichiers Markdown depuis votre ordinateur pour les modifier ou les copier dans un projet. Pour prévisualiser l’ensemble de votre site en local, utilisez la CLI.
L'application de bureau ouverte sur la page de démarrage rapide de Mintlify.L'application de bureau ouverte sur la page de démarrage rapide de Mintlify.

​
Installation

Nécessite macOS 14 ou une version ultérieure sur Apple silicon.
  1. Téléchargez l’application de bureau depuis mintlify.com/desktop.
  2. Ouvrez le fichier.
  3. Faites glisser Mintlify dans votre dossier Applications.
Vous pouvez aussi l’installer depuis le terminal.
Install the desktop app
Le script installe l’application dans /Applications, ou dans ~/Applications si vous ne pouvez pas écrire dans /Applications.

​
Connexion

L’application de bureau vous connecte avec le compte Mintlify que vous utilisez déjà dans votre navigateur par défaut.
  1. Ouvrez l’application de bureau. L’application affiche un écran Log in to Mintlify.
  2. Cliquez sur Continue in browser. Votre navigateur par défaut ouvre une page de consentement Mintlify qui affiche votre compte et votre organisation.
  3. Cliquez sur Approve. Pour vous connecter à une autre organisation, cliquez d’abord sur Use a different organization.
  4. Revenez à l’application de bureau. L’application vous connecte.
L’application de bureau et votre navigateur partagent la même session. Vous déconnecter de l’un vous déconnecte de l’autre.

​
Se connecter sans le navigateur

La connexion via le navigateur n’est pas disponible pour certaines organisations, comme celles qui définissent une durée de session maximale. Si la page de consentement indique que la connexion de bureau n’est pas disponible, connectez-vous dans l’application :
  1. Sur l’écran Log in to Mintlify, cliquez sur Log in here instead.
  2. Connectez-vous de la même manière que vous vous connectez à votre Dashboard dans le navigateur.

​
Onglets et fenêtres

Ouvrez chaque page sur laquelle vous travaillez dans son propre onglet ou sa propre fenêtre. Les onglets et fenêtres se rouvrent là où vous les avez laissés lorsque vous redémarrez l’application. Faites un clic droit sur un onglet pour le dupliquer, copier son lien ou fermer les autres onglets. Faites un clic du milieu sur un onglet pour le fermer. Pour afficher les onglets dans une barre latérale plutôt qu’en haut de la fenêtre, modifiez la disposition des onglets dans les Paramètres.

​
Les onglets partagent une même session

Tous les onglets et toutes les fenêtres partagent une même session. Se déconnecter ou changer d’organisation dans un onglet s’applique à tous les onglets, et l’application recharge vos onglets ouverts. Si une autre personne se connecte, l’application efface d’abord les données stockées. Si vous vous êtes connecté via votre navigateur, il est possible que le changement d’organisation dans l’application de bureau ne soit pas encore pris en charge. Lorsque l’application affiche un message indiquant que le changement n’est pas pris en charge, déconnectez-vous, puis reconnectez-vous et choisissez l’organisation souhaitée. Sur la page de consentement, cliquez sur Use a different organization pour la sélectionner. Les onglets chargent uniquement le Dashboard Mintlify et les services qu’il utilise pour la connexion, la facturation, la connexion des fournisseurs Git et la connexion de Slack. Les liens vers tout autre site s’ouvrent dans votre navigateur par défaut. Les liens qui commencent par mintlify:// s’ouvrent dans l’application de bureau. Partagez-les dans Slack, ajoutez-les à votre documentation ou collez-les dans la barre d’adresse de votre navigateur. L’application ouvre la page dans un nouvel onglet de votre fenêtre actuelle et place la fenêtre au premier plan. Pour écrire un lien mintlify://, remplacez https://app.mintlify.com/ par mintlify:// dans une URL du Dashboard. Par exemple, ce lien ouvre la même page que https://app.mintlify.com/acme/docs/editor :
L’application ignore les liens mintlify:// qui sortiraient du Dashboard Mintlify. Pour ouvrir les liens mintlify:// dans votre navigateur par défaut, désactivez Open Mintlify links in the app dans les Paramètres.

​
Ouvrir des pages du Dashboard depuis votre navigateur

Une fois connecté à l’application de bureau via votre navigateur, ce navigateur ouvre par défaut les pages du Dashboard dans l’application. Lorsque vous ouvrez un lien du Dashboard depuis l’extérieur du Dashboard, par exemple depuis Slack ou un e-mail, le navigateur affiche une page Redirecting to Mintlify Desktop… et la page s’ouvre dans l’application de bureau. Les liens que vous suivez dans le Dashboard restent dans votre navigateur. Si votre navigateur demande l’autorisation d’ouvrir Mintlify, accordez-la. Pour ne plus voir cette demande, choisissez de toujours autoriser les liens Mintlify. Pour ouvrir un seul lien dans votre navigateur, cliquez sur Or continue in browser sur la page de redirection. Pour ne plus ouvrir les pages du Dashboard dans l’application, cliquez sur Stop opening Mintlify Desktop automatically sur la page de redirection ou désactivez Always open in desktop app dans vos paramètres de Profil. Les deux options s’appliquent uniquement au navigateur actuel. Les pages du Dashboard s’ouvrent ainsi dans l’application même lorsque Open Mintlify links in the app est désactivé.

​
Ouvrir des fichiers locaux

Ouvrez un fichier Markdown depuis votre ordinateur pour l’afficher et le modifier dans l’éditeur. L’application de bureau ouvre les fichiers .md, .mdx, .markdown et .txt jusqu’à 5 Mo. Pour ouvrir un fichier, sélectionnez File > Open File… ou appuyez sur Cmd + O. Le fichier s’ouvre dans un nouvel onglet.
  • Le mode Visual affiche le fichier avec les composants Mintlify comme les callouts, les cartes, les étapes et les blocs de code.
  • Le mode Markdown affiche le code source. Utilisez-le pour le contenu que l’éditeur visuel ne peut pas afficher.
Appuyez sur Cmd + S ou cliquez sur Save pour enregistrer vos modifications dans le fichier. L’application de bureau conserve le frontmatter du fichier tel quel. L’enregistrement depuis le mode Visual peut reformater une partie du Markdown, comme les marqueurs de liste et les espacements. Le mode Visual n’applique pas le thème de votre site et ne charge pas les snippets ni les images relatives. Les onglets de fichiers locaux ne se rouvrent pas lorsque vous redémarrez l’application. Vous n’avez pas besoin d’être connecté pour ouvrir et modifier des fichiers locaux.

​
Copier un fichier dans un projet

Lorsque vous êtes connecté, vous pouvez ajouter un fichier local à l’un des projets de votre organisation en tant que nouvelle page.
  1. Cliquez sur Copy to project.
  2. Sélectionnez un projet.
L’application de bureau ouvre le projet dans l’éditeur dans un nouvel onglet et ajoute le fichier comme nouvelle page à la fin de votre navigation. Le titre et la description de la page proviennent du frontmatter du fichier. Publiez la page comme toute autre modification.

​
Raccourcis clavier

Sur Windows et Linux, utilisez Ctrl au lieu de Cmd. Pour les raccourcis dans l’éditeur, consultez Raccourcis clavier.

​
Paramètres

Ouvrez les paramètres avec Cmd + , sur macOS ou Ctrl + , sur Windows et Linux.
  • Tab layout : Affichez les onglets en haut de la fenêtre (Horizontal) ou dans une barre latérale (Vertical).
  • Open Mintlify links in the app : Ouvrez les liens mintlify:// dans l’application. Activé par défaut. Lorsque l’option est désactivée, ces liens s’ouvrent dans votre navigateur par défaut.
  • Check for updates : Vérifiez si une nouvelle version de l’application est disponible. Consultez Mises à jour.
  • Clear all data : Déconnectez-vous de tous les onglets, fermez tous les onglets et réinitialisez les paramètres. L’application redémarre.
La fenêtre des paramètres affiche également la version de l’application.

​
Mises à jour

L’application recherche des mises à jour au démarrage, puis toutes les quatre heures pendant son exécution. Lorsqu’une mise à jour est disponible, un bouton Update available apparaît dans la barre d’onglets. Pour rechercher manuellement une mise à jour, cliquez sur Check for updates dans les Paramètres. Vous pouvez aussi sélectionner Check for Updates… dans le menu de l’application. Sur macOS, cette option se trouve sous About Mintlify dans le menu Mintlify. Sur Windows et Linux, elle se trouve en bas du menu File. Une boîte de dialogue indique si une mise à jour est disponible et vous permet de l’installer.
  • macOS : Cliquez sur Update dans la boîte de dialogue, ou sur Update available dans la barre d’onglets, pour télécharger la mise à jour. Une fois le téléchargement terminé, cliquez sur Restart to update.
  • Windows et Linux : Cliquez sur Update pour télécharger la nouvelle version depuis votre navigateur, puis installez-la.

​
Désinstallation

  1. Quittez l’application de bureau.
  2. Déplacez Mintlify de votre dossier Applications vers la Corbeille.
  3. Pour supprimer votre connexion et vos paramètres, supprimez ~/Library/Application Support/Mintlify Electron.