Jamdesk Documentation logo

Extension VS Code

Démarrez, arrêtez et redémarrez le serveur de développement Jamdesk depuis la barre d'état de Visual Studio Code avec des contrôles en un clic et un aperçu automatique dans le navigateur.

Prévisualisez votre documentation sans quitter Visual Studio Code. L'extension Jamdesk ajoute un bouton dans la barre d'état qui démarre jamdesk dev, surveille le serveur et ouvre votre navigateur lorsqu'il est prêt. Aucun terminal requis.

Prérequis

  • Jamdesk CLI installé (npm install -g jamdesk)
  • Un espace de travail contenant un fichier docs.json

Installer l'extension

Recherchez Jamdesk dans le panneau Extensions de VS Code (Cmd+Shift+X sur macOS, Ctrl+Shift+X sur Windows/Linux) et cliquez sur Installer. Ou installez directement depuis le VS Code Marketplace.

L'extension s'active automatiquement lorsque votre espace de travail contient un fichier docs.json. Un bouton de lecture apparaît dans la barre d'état.

Démarrer le serveur de développement

Cliquez sur le bouton de lecture dans la barre d'état pour démarrer le serveur de développement. L'extension :

  1. Lance jamdesk dev en tant que processus enfant
  2. Surveille la sortie pour détecter lorsque le serveur est prêt
  3. Ouvre votre navigateur vers le preview local (si l'ouverture automatique est activée)

La barre d'état affiche l'état actuel du serveur : démarrage, en cours d'exécution ou arrêté.

Commandes

Ouvrez la palette de commandes (Cmd+Shift+P / Ctrl+Shift+P) et tapez "Jamdesk" pour accéder à :

CommandeDescription
Jamdesk: Start Dev ServerDémarrer le serveur de développement
Jamdesk: Stop Dev ServerArrêter le serveur en cours d'exécution
Jamdesk: Restart Dev ServerRedémarrer le serveur
Jamdesk: Show OutputAfficher le canal de sortie CLI

Paramètres

Configurez l'extension dans les paramètres VS Code (Cmd+, / Ctrl+,) sous Jamdesk :

ParamètreDéfautDescription
jamdesk.port3000Port préféré du serveur de développement
jamdesk.verbosefalseActiver la sortie CLI détaillée
jamdesk.cleanfalseVider le cache de build au prochain démarrage
jamdesk.browserModeexternalOù ouvrir le preview : external (navigateur système) ou embedded (panneau latéral VS Code)
jamdesk.autoOpenBrowsertrueOuvrir le navigateur lorsque le serveur est prêt

Définissez browserMode sur embedded pour ouvrir le preview de la documentation dans un panneau latéral VS Code. Cela vous permet d'éditer et de prévisualiser côte à côte sans changer de fenêtre.

Gestion intelligente des ports

Si votre port préféré est déjà utilisé, le CLI passe automatiquement au prochain port disponible. L'extension détecte le port réel depuis la sortie CLI, de sorte que le navigateur s'ouvre toujours vers l'URL correcte.

Canal de sortie

L'extension diffuse toute la sortie CLI vers un canal de sortie Jamdesk dédié. Ouvrez-le avec la commande Jamdesk: Show Output ou depuis le menu déroulant du panneau Sortie.

Utilisez-le pour :

  • Surveiller la progression du build
  • Déboguer les problèmes du serveur
  • Afficher les journaux détaillés (lorsque jamdesk.verbose est activé)

Et ensuite ?

Preview local

Preview basé sur le CLI avec ports personnalisés et mode détaillé

Vue d'ensemble CLI

Référence complète des commandes CLI