Jamdesk Documentation logo

Vue d'ensemble des composants

Découvrez les composants MDX de Jamdesk : cartes, onglets, encadrés et blocs de code, pour trouver celui qui convient à votre contenu.

Jamdesk inclut des composants MDX que vous pouvez utiliser dans n'importe quelle page. Cet aperçu vous aide à choisir le bon composant pour votre contenu.

Utilisation

Intégrez les composants directement dans votre MDX :

<Card title="Quickstart" icon="rocket" href="/quickstart">

  Launch your docs in minutes.

</Card>

Mise en page et navigation

Accordéon

Sections repliables pour développer uniquement ce dont les utilisateurs ont besoin. Idéal pour les FAQ, les listes de fonctionnalités et la configuration.

Card

Utilisez le composant Card pour mettre en avant du contenu, créer des liens vers d'autres pages ou regrouper des informations en sections.

Colonnes

Grille responsive pour afficher Cards, Tiles et autre contenu côte à côte. S'adapte automatiquement à la taille de l'écran.

Frame

Frame place images et démos dans un conteneur bordé avec légendes optionnelles, pour une cohérence visuelle de la documentation.

Panel

Utilisez Panel pour épingler du contenu comme des avertissements ou des références rapides dans la barre latérale, visible même en défilant.

Étapes

Guides étape par étape numérotés pour configuration, tutoriels et dépannage. Compatibles avec icônes, blocs de code et contenu imbriqué.

Onglets

Panneaux pour du contenu mutuellement exclusif (gestionnaires de paquets, langages). Les titres correspondants se synchronisent sur toute la page.

Tile

Les tuiles affichent des aperçus de contenu avec un motif d'arrière-plan stylisé. À utiliser pour intégrations, modèles ou galeries visuelles.

Arborescence

Affichez les hiérarchies de fichiers et dossiers avec développement/réduction interactifs et navigation au clavier. Idéal pour les structures de projet.

View

Créez une documentation qui s'adapte au framework ou à la langue choisis par le lecteur. Des sections entières changent selon la sélection.

Contenu et mise en valeur

Étiquette (Badge)

Étiquettes inline pour le statut, les catégories et les métadonnées -- 11 variantes de couleurs, 4 tailles, icônes et formes pilule ou contours en trait.

Callouts

Découvrez comment utiliser Note, Tip, Warning, Danger, Check et le composant Callout personnalisé pour mettre en avant des informations clés.

Expandable

Expandable crée un simple bouton d'affichage/masquage pour du contenu que les lecteurs peuvent vouloir voir mais qui n'est pas essentiel au flux principal.

Info-bulle

Affichez définitions et contexte au survol. Définissez des termes, expliquez des acronymes ou créez des liens vers du contenu connexe.

Mise à jour

Entrées de changelog au format chronologique avec dates, descriptions et tags de catégorie. S'intègre à votre Table des matières pour la navigation.

Visibilité

Affichez un contenu différent aux humains et aux agents IA sur la même page. Contexte et instructions réservés aux agents, hors de la documentation rendue.

Code et données

CodeGroup

Affichez des blocs de code dans une interface à onglets. Montrez la même opération en plusieurs langages (cURL, Python, JavaScript).

Exemples

Épinglez des blocs de code dans une barre latérale droite persistante sur desktop. Plusieurs langages avec onglets, lisibles en faisant défiler.

Champs

Documentez paramètres API et champs de réponse avec ParamField et ResponseField. Prend en charge les types, les valeurs par défaut et les objets imbriqués.

Prompt

Utilisez Prompt pour présenter des instructions d’IA réutilisables avec copie, actions d’ouverture intégrées, destinations, icônes et affichage compact.

Tableaux

Organisez les données en lignes et colonnes. Prend en charge les tableaux Markdown et les composants Table avec tri, mise en évidence et fusion de cellules.

Diagrammes et visuels

Couleur

Le composant Color affiche des palettes de couleurs pour documenter des systèmes de design, des chartes graphiques ou toute spécification de couleur.

Diagrammes Mermaid

Créez flowcharts, diagrammes de séquence, timelines, camemberts et plus depuis la syntaxe Mermaid. Diagrammes générés en SVG au build.

Diagrammes D2

Générez des diagrammes d'architecture, organigrammes, séquences et modèles SQL en syntaxe D2. Rendu SVG avec thème clair/sombre automatique.

Engagement

EmailSubscribe

Ajoutez un formulaire d'inscription à une newsletter ou un changelog sur n'importe quelle page de documentation avec le composant EmailSubscribe.

Widget

Intégrez une démo du widget Nouveautés dans vos docs avec le composant MDX Widget : un bouton qui ouvre votre changelog en modal, sans script.