Jamdesk Documentation logo

Documentation Jamdesk

Créez des docs prêtes pour l'IA avec Jamdesk, un outil de documentation logicielle basé sur MDX et GitHub. Déployez en quelques secondes avec recherche, analytique et thèmes intégrés.

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 globalement en quelques secondes. Vous n'avez pas besoin de configurer un pipeline de build ni de gérer vous-même du DevOps. Chaque site génère un fichier llms.txt pour que les outils IA puissent indexer votre contenu.

Rédigez avec l'IA. Utilisez Cursor, Claude, ou tout autre assistant IA pour générer et modifier vos docs. MDX est un format texte que les outils IA comprennent nativement — aucun prompt spécial n'est nécessaire.

Un projet Jamdesk minimal

my-docs/
├── docs.json
└── introduction.mdx

C'est tout ce qu'il vous faut. Consultez le Quickstart 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.

Ce qui est inclus

Déployez en quelques secondes

Poussez vers GitHub et vos docs sont déployées sur un CDN mondial. Pas de configuration de build ni de pipeline CI.

Rédigez en MDX

Markdown standard avec des composants React pour les éléments interactifs.

Thèmes et identité visuelle

Choisissez parmi Jam, Nebula ou Pulsar, puis personnalisez les couleurs, polices et styles pour correspondre à votre identité.

Recherche intégrée

Recherche Cmd+K qui indexe votre contenu automatiquement.

Besoin de docs privées ? Protégez l'intégralité de votre site par un mot de passe, limitez l'accès à des pages individuelles avec private: true, ou utilisez le SSO en Enterprise. Voir Contrôle d'accès.

Comment ça fonctionne

1
Rédigez en MDX

Créez de la documentation en Markdown avec des composants React optionnels. Utilisez votre éditeur favori : VS Code, Cursor, ou n'importe quel éditeur de texte. Les outils IA comme Claude peuvent générer et modifier du MDX nativement.

2
Poussez vers GitHub

Commitez vos modifications et poussez. Vous n'avez pas besoin d'exécuter une commande de build ni de maintenir un script de déploiement.

3
En ligne en quelques secondes

Jamdesk détecte votre push, génère votre site et le déploie sur un CDN mondial. Vos docs sont en ligne à l'adresse your-project.jamdesk.app.

Ce que vous pouvez créer

Guides utilisateur, documentation des fonctionnalités et centres d'aide. Une navigation claire aide les utilisateurs à trouver des réponses rapidement. Voir les composants →

Autres fonctionnalités

Chat IA

Un assistant de chat intégré répond aux questions des visiteurs à partir de vos docs.

Intégration MCP

Les agents IA interrogent vos docs via le Model Context Protocol.

Analytique intégrée

Vues de pages, requêtes de recherche et données géographiques sans outils tiers.

Support OpenAPI

Générez automatiquement des pages API à partir de votre spec OpenAPI 3.0+.

Domaines personnalisés

Servez depuis docs.votreentreprise.com avec SSL automatique.

SEO prêt à l'emploi

Balises meta, images Open Graph et sitemaps générés automatiquement.

Pour commencer

Quickstart

Déployez votre premier site de documentation en 5 minutes

Guide CLI

Configurez le développement local

Bases de MDX

Apprenez à rédiger de la documentation

Composants

Explorez les composants disponibles