Jamdesk Documentation logo

Les 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 combine la simplicité de Markdown avec la puissance de JSX. Rédigez des titres, des listes et des blocs de code en Markdown, puis insérez des composants comme <Card> ou <Tabs> là où vous avez besoin d'interactivité.

MDX est également l'un des meilleurs formats pour la documentation qui doit être lisible par l'IA. C'est du texte brut (les outils IA peuvent donc le lire et l'écrire nativement), versionnable dans Git, et suffisamment structuré pour les composants sans nécessiter un 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>

Structure d'une page

Chaque page MDX commence par un frontmatter - des métadonnées entre triples tirets :

---
title: My Page Title
description: A brief description for search and previews
---

Your content starts here...

Le title et la 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.

Fondamentaux 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

SyntaxeRésultat
**bold**bold
*italic*italic
~~strikethrough~~strikethrough
`inline code`inline code

Listes

Unordered list:
- First item
- Second item
  - Nested item

Ordered list:
1. First step
2. Second step
3. Third step

Citations

> This is a blockquote. Use it for callouts or
> highlighting important information.

Ceci est une citation. Utilisez-la pour les encadrés ou pour mettre en valeur des informations importantes.

Ajout de composants

Les composants sont des éléments JSX que vous pouvez utiliser n'importe où dans votre MDX. Ils sont auto-fermants ou encapsulent 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 un ensemble riche de composants intégrés :

Cards

Mettez en valeur des fonctionnalités et créez une navigation

Tabs

Organisez le contenu en panneaux commutables

Accordion

Sections repliables pour du contenu optionnel

Steps

Procédures numérotées et tutoriels

Tableaux

Les tableaux Markdown standard fonctionnent directement :

| Feature | Free | Pro |
|---------|------|-----|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes |
FeatureFreePro
Pages10Unlimited
Custom domainNoYes

Pour les fonctionnalités avancées comme la mise en surbrillance des lignes, l'alignement des cellules et les fusions, utilisez le composant Table :

FeatureFreePro
Pages10Unlimited
Custom domainNoYes

Consultez Tables pour la documentation complète du composant, incluant la mise en surbrillance des lignes/cellules, la fusion de colonnes et les options de style.

Commentaires

Ajoutez des commentaires qui n'apparaîtront pas dans le rendu final :

{/* This is a comment - it won't be visible to readers */}

Et ensuite ?

Optimisation SEO

Améliorez la découvrabilité et les métadonnées

Frontmatter

Définissez les titres, descriptions et champs SEO