Preview locale

Exécutez jamdesk dev (ou npx jamdesk dev) depuis tout répertoire contenant un fichier docs.json pour démarrer un serveur local avec rechargement à chaud, recherche complète et tous les composants fonctionnant exactement comme en production.

Prérequis

Avant de commencer, assurez-vous de disposer de :

Node.js 20+ - Vérifiez avec node --version
Un projet de documentation - Avec un fichier de configuration docs.json

Démarrer le serveur de développement

Installez le CLI globalement, puis exécutez-le depuis votre répertoire de documentation :

npm install -g jamdesk
cd your-docs
jamdesk dev

Votre documentation sera disponible à l'adresse http://localhost:3000

Ce que vous obtenez

Rechargement à chaud

Modifiez les fichiers MDX et visualisez les changements instantanément. Les modifications apportées à docs.json et à votre style.css sont prises en compte au rechargement.

Recherche complète

Testez la recherche Cmd+K avec votre contenu réel

Tous les composants

Chaque composant fonctionne exactement comme en production

Changement de thème

Testez les modes clair et sombre

Port personnalisé

Le port par défaut est 3000. S'il est déjà utilisé, spécifiez-en un autre :

jamdesk dev --port 3001

Ou définissez un port par défaut permanent dans ~/.jamdeskrc :

{
  "defaultPort": 3001
}

Mode verbose

Affichez des informations de build détaillées avec le flag --verbose :

jamdesk dev --verbose

Cela affiche :

La détection des modifications de fichiers
Les durées de build
L'analyse de la navigation
Les avertissements ou erreurs

Performances au premier démarrage

La première fois que vous exécutez jamdesk dev, les dépendances sont installées dans ~/.jamdesk. Cela prend 30 à 60 secondes. Les démarrages suivants s'effectuent en moins de 5 secondes.

Pour vider le cache et forcer une nouvelle installation :

jamdesk clean
jamdesk dev

Dépannage

Un autre processus utilise le port 3000.

Option 1 : Utilisez un port différent

jamdesk dev --port 3001

Option 2 : Trouvez et arrêtez le processus

lsof -i :3000
kill -9 <PID>

Assurez-vous de vous trouver dans le répertoire contenant votre fichier docs.json :

ls docs.json  # Should show the file
jamdesk dev

Essayez ces étapes :

Vérifiez les erreurs dans le terminal
Effectuez un rechargement forcé du navigateur (Cmd+Shift+R)
Redémarrez le serveur de développement
Exécutez jamdesk clean et réessayez

Exécutez les diagnostics :

jamdesk doctor

Cette commande vérifie votre environnement et identifie les problèmes.

Et ensuite ?

Extension VS Code

Démarrez le serveur de développement depuis la barre de statut de VS Code

Déploiement

Découvrez le processus de build et de déploiement