Jamdesk Documentation logo

En-têtes

Structurez les pages avec des en-têtes H2 et H3 qui alimentent automatiquement la table des matières côté droit et génèrent des liens d'ancre partageables.

Les en-têtes Markdown (##, ###) divisent votre page en sections que les lecteurs peuvent parcourir rapidement. Jamdesk récupère les en-têtes H2 et H3 pour la table des matières côté droit et génère des liens d'ancre que vous pouvez partager directement.

Utilisation de base

Utilisez les en-têtes Markdown standard pour structurer votre contenu :

## Section Title

Content goes here...

### Subsection

More detailed content...

Les en-têtes H2 et H3 apparaissent dans la Table des matières côté droit, aidant les lecteurs à naviguer dans les longues pages.

Liens d'ancre

Chaque en-tête génère automatiquement un identifiant d'ancre à partir de son texte :

En-têteAncre générée
## Getting Started#getting-started
## API Reference#api-reference
### User Authentication#user-authentication

Partager des liens d'en-tête

Survolez n'importe quel en-tête H2 ou H3 pour révéler une icône de lien. Cela facilite le partage de liens directs vers des sections spécifiques :

  • Cliquez sur l'icône de lien pour copier l'URL dans votre presse-papiers
  • Cliquez sur le texte de l'en-tête pour copier l'URL et naviguer vers cette section

L'icône de lien apparaît dans une petite boîte encadrée à gauche de l'en-tête. Lorsque vous copiez un lien, l'icône change brièvement de couleur pour confirmer l'action.

Sur les appareils mobiles, l'icône de lien est masquée car il n'y a pas d'état de survol. Les en-têtes fonctionnent toujours normalement pour la navigation.

Créer des liens vers des en-têtes

Référencez des sections spécifiques depuis d'autres pages en utilisant l'ancre :

See the [headings section](/content/mdx-basics#headings) for details.

Bonnes pratiques

Commencez par H2 pour les sections principales, H3 pour les sous-sections :

## Installation

### Prerequisites

### Quick Install

## Configuration

### Basic Options

### Advanced Options

Évitez de sauter des niveaux (par exemple, passer de H2 à H4).

Les en-têtes courts sont plus faciles à parcourir :

{/* Good */}
## Authentication

{/* Avoid */}
## How to Set Up Authentication in Your Application

Mettez en majuscule uniquement le premier mot et les noms propres :

{/* Good */}
## Getting started with the API

{/* Avoid */}
## Getting Started With The API

Et ensuite ?

Optimisation SEO

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

Frontmatter

Définissez les titres, descriptions et champs SEO