Preview local

Exécutez jamdesk dev (ou npx jamdesk dev) depuis n'importe quel répertoire contenant un 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 d'avoir :

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 voyez les changements instantanément. Les modifications de configuration dans docs.json sont prises en compte lors du rafraîchissement.

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 l'option --verbose :

jamdesk dev --verbose

Cela affiche :

Détection des modifications de fichiers
Durée du build
Analyse de la navigation
Avertissements ou erreurs éventuels

Performance au premier lancement

La première fois que vous exécutez jamdesk dev, il installe les dépendances dans ~/.jamdesk. Cela prend 30 à 60 secondes. Les lancements suivants démarrent 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 : Utiliser un port différent

jamdesk dev --port 3001

Option 2 : Trouver et arrêter le processus

lsof -i :3000
kill -9 <PID>

Assurez-vous d'être dans le répertoire contenant votre fichier docs.json :

ls docs.json  # Should show the file
jamdesk dev

Essayez ces étapes :

Vérifiez le terminal pour détecter des erreurs
Rechargez la page en forçant le cache (Cmd+Shift+R)
Redémarrez le serveur de développement
Exécutez jamdesk clean et réessayez

Exécutez les diagnostics :

jamdesk doctor

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

Et ensuite ?

Extension VS Code

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

Déploiement

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