Documentation Jamdesk
Créez des docs prêtes pour l'IA avec Jamdesk, un outil de documentation basé sur MDX et GitHub. Déployez en quelques secondes.
Jamdesk est un outil de documentation logicielle qui génère des sites de documentation à partir de vos fichiers Markdown. Connectez un dépôt GitHub, rédigez en MDX et déployez mondialement en quelques secondes. Vous n'avez pas besoin de configurer un pipeline de build ni de gérer le DevOps vous-même. Chaque site génère un fichier llms.txt que les outils d'IA utilisent pour indexer votre contenu.
Rédigez avec l'IA. Utilisez Cursor, Claude ou tout assistant IA pour générer et modifier votre documentation. Les outils d'IA lisent le MDX nativement. Aucun prompt spécial n'est nécessaire.
一个最小化的 Jamdesk 项目
my-docs/
├── docs.json
└── introduction.mdxC'est tout ce dont vous avez besoin. Consultez le Démarrage rapide pour créer le vôtre.
Parcourez le code source de cette documentation sur GitHub. C'est un projet Jamdesk fonctionnel que vous pouvez utiliser comme référence.
包含的功能
Besoin de documentation privée ? Verrouillez tout votre site par mot de passe, protégez des pages individuelles avec private: true, ou utilisez le SSO sur Enterprise. Voir Contrôle d'accès.
工作原理
Créez votre documentation en Markdown avec des composants React optionnels. Utilisez l'éditeur de votre choix : VS Code, Cursor ou tout éditeur de texte brut. Des outils d'IA comme Claude peuvent générer et modifier le MDX nativement.
Validez vos modifications et poussez-les. Vous n'avez pas besoin d'exécuter une commande de build ni de maintenir un script de déploiement.
Jamdesk détecte votre push, génère votre site et le déploie sur un CDN mondial. Votre documentation est en ligne sur your-project.jamdesk.app.
可构建的内容
Guides utilisateur, documentation des fonctionnalités et centres d'aide. Une navigation claire aide les lecteurs à trouver des réponses. Voir les composants →