Bases de MDX
Rédigez de la documentation en Markdown avec des composants React intégrés comme Card, Tabs et Accordion, la syntaxe derrière chaque page Jamdesk.
Chaque page Jamdesk est un fichier .mdx : du Markdown standard avec des composants JSX comme <Card>, <Tabs> et <Accordion>.
Qu'est-ce que MDX ?
MDX vous permet d'écrire du Markdown standard et d'intégrer des composants JSX dans le même fichier. Rédigez des titres, des listes et des blocs de code en Markdown, puis ajoutez des composants comme <Card> ou <Tabs> partout où vous avez besoin d'interactivité.
MDX fonctionne également très bien pour la documentation que les outils d'IA doivent lire : c'est du texte brut (ils peuvent donc le lire et l'écrire nativement), versionnable dans Git, et suffisamment structuré pour les composants sans nécessiter de format propriétaire.
# Welcome to My Docs
This is regular **Markdown** with a component below:
<Card title="Quickstart" icon="rocket" href="/quickstart">
Jump right in with our quickstart guide.
</Card>Deux outils gratuits dans le navigateur vous aident pendant la rédaction : le MDX Validator détecte les erreurs de syntaxe avant un build, et le MDX Formatter nettoie l'espacement et l'indentation. Collez une page pour la vérifier ou la nettoyer sans exécuter le CLI.
Structure de page
Chaque page MDX commence par du frontmatter - des métadonnées entre triples tirets :
---
title: My Page Title
description: A brief description for search and previews
---
Your content starts here...Les champs title et description apparaissent dans les résultats de recherche, les onglets du navigateur et les aperçus sur les réseaux sociaux. Rédigez-les avec soin.
Éléments essentiels de Markdown
Titres
Utilisez ## pour les sections principales et ### pour les sous-sections. Jamdesk génère automatiquement une table des matières à partir de vos titres.
## Main Section
Content under the main section.
### Subsection
More detailed content here.Commencez par ## (h2) pour votre premier titre. Le titre de la page issu du frontmatter sert de h1.
Mise en forme du texte
| Syntaxe | Résultat |
|---|---|
**bold** | gras |
*italic* | italique |
~~strikethrough~~ | |
`inline code` | code en ligne |
Listes
Unordered list:
- First item
- Second item
- Nested item
Ordered list:
1. First step
2. Second step
3. Third stepCitations
> This is a blockquote. Use it for callouts or
> highlighting important information.Ceci est une citation. Utilisez-la pour des encadrés ou pour mettre en évidence des informations importantes.
Ajouter des composants
Les composants sont des éléments JSX que vous pouvez utiliser n'importe où dans votre MDX. Ils sont auto-fermants ou entourent du contenu :
{/* Self-closing component */}
<Card title="Example" icon="star" href="/introduction" />
{/* Component wrapping content */}
<Accordion title="Click to expand">
This content is inside the accordion.
</Accordion>Composants disponibles
Jamdesk fournit ces composants intégrés :
Tableaux
Les tableaux Markdown standard fonctionnent directement :
| Feature | Free | Pro |
|---------|------|-----|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes || Fonctionnalité | Free | Pro |
|---|---|---|
| Pages | 10 | Illimité |
| Domaine personnalisé | Non | Oui |
Pour des fonctionnalités avancées comme la mise en évidence de lignes, l'alignement des cellules et la fusion, utilisez le composant Table :
| Feature | Free | Pro |
|---|---|---|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes |
Consultez Tables pour la documentation complète du composant, incluant la mise en évidence de lignes/cellules, la fusion de colonnes et les options de style.
Commentaires
Ajoutez des commentaires qui n'apparaîtront pas dans le résultat rendu :
{/* This is a comment - it won't be visible to readers */}