IDs de Titres

Les IDs de titres sont une extension de Markdown permettant d'ajouter des identifiants personnalisés aux titres, facilitant la création de liens précis et le contrôle de la structure du document.

Syntaxe de Base

Ajouter des IDs de Titre

Les IDs de titre utilisent la syntaxe d'accolades, placée après le texte du titre :

## Mon Titre {#id-personnalise}

Effet de Rendu :

La sortie HTML ajoutera cet ID personnalisé à l'élément titre :

<h2 id="id-personnalise">Mon Titre</h2>

IDs sur Plusieurs Niveaux de Titres

Tous les niveaux de titres peuvent avoir des IDs personnalisés :

# Titre de Niveau 1 {#niveau-1}

## Titre de Niveau 2 {#niveau-2}

### Titre de Niveau 3 {#niveau-3}

#### Titre de Niveau 4 {#niveau-4}

Scénarios d'Application

Créer des Liens d'Ancre

Avec des IDs personnalisés, vous pouvez créer des liens pointant vers des parties spécifiques d'un document :

[Cliquez pour aller à mon titre](#id-personnalise)

...autre contenu...

## Mon Titre {#id-personnalise}

Effet de Rendu :

Cliquer sur le lien amènera directement au titre avec id-personnalise.

Liens Externes vers des Sections Spécifiques

Les IDs personnalisés facilitent aussi la création de liens depuis d'autres documents vers un contenu précis :

[Lien vers une section spécifique d'un autre document](autre-doc.html#section-specifique)

Partager des Sections Spécifiques via URL

Les titres avec IDs peuvent être partagés via URL pour pointer vers des sections précises :

https://www.markdownlang.com/documentation.html#guide-installation

Utilisation Avancée

IDs de Titres Multi-mots

Quand les titres contiennent plusieurs mots, les IDs utilisent généralement des tirets :

## Guide d'Installation et de Configuration {#installation-et-configuration}

Génération de Table des Matières et IDs de Titres

De nombreux processeurs Markdown génèrent automatiquement des IDs à partir du contenu du titre. Avec des IDs personnalisés, vous pouvez garantir que les liens de la table des matières restent stables même si le texte du titre change :

## Guide de Démarrage {#demarrage}

Même si vous modifiez plus tard le titre, le lien reste valide car l'ID ne change pas.

Internationalisation et Caractères Non-Anglais

Pour les titres non anglais, les IDs personnalisés sont particulièrement utiles pour fournir des identifiants anglais stables :

## Instructions d'Installation {#installation}

## Guide d'Utilisation {#utilisation}

## Foire Aux Questions {#faq}

Compatibilité et Différences d'Implémentation

Prise en Charge selon les Plateformes

Plateforme/Outil	Prise en charge des IDs de titre	Syntaxe
GitHub Markdown	✅	{#id}
GitLab Markdown	✅	{#id}
Jekyll (kramdown)	✅	{:#id} ou {#id}
Hugo	✅	{#id}
CommonMark	❌	Non supporté
VitePress	✅	{#id}
Pandoc	✅	{#id}

Règles de Génération Automatique d'ID

Quand aucun ID personnalisé n'est fourni, la plupart des processeurs Markdown génèrent automatiquement des IDs à partir du texte du titre :

1. Conversion en minuscules
2. Suppression ou remplacement des caractères spéciaux
3. Remplacement des espaces par des tirets
4. Suppression des tirets en double
5. Unicité de l'ID (souvent par ajout d'un suffixe numérique)

Par exemple :

Titre	ID auto-généré
## Démarrage Rapide	#demarrage-rapide
## FAQ & Aide	#faq-aide
## Démarrage	#demarrage ou #section-1 (selon la plateforme)

Bonnes Pratiques

Convention de Nommage des IDs

✅ Pratiques recommandées :

1. **Utiliser des IDs descriptifs et concis** :
   - `{#installation}`
   - `{#reference-api}`
   - `{#depannage}`

2. **Garder un style cohérent** :
   - Tout en minuscules
   - Utiliser des tirets pour séparer les mots
   - Éviter les underscores ou le camelCase

3. **Stabilité des IDs** :
   - Éviter de changer fréquemment les IDs
   - Conserver les IDs lors de la modification du texte du titre

❌ À éviter :

1. Utiliser des caractères spéciaux (`!@#$%^&*()`)
2. Utiliser des IDs non descriptifs (`{#section1}`)
3. Créer des IDs trop longs
4. Utiliser des espaces ou de la ponctuation

Structure du Document et IDs de Titres

Pour les documents volumineux, il est recommandé d'utiliser des IDs standardisés pour les chapitres principaux afin de faciliter la navigation :

# Documentation Produit {#doc-produit}

## Introduction {#introduction}

## Installation {#installation}

### Installation Windows {#installation-windows}

### Installation macOS {#installation-macos}

### Installation Linux {#installation-linux}

## Configuration {#configuration}

## Référence API {#reference-api}

## FAQ {#faq}

Exemples Pratiques

IDs de Titres dans la Documentation Technique

Les IDs de titres dans la documentation technique permettent aux utilisateurs de lier directement des sections spécifiques :

# Documentation API {#documentation-api}

## Authentification {#authentification}

### Obtenir des Clés API {#obtenir-cle-api}

### Authentification OAuth {#oauth}

## Endpoints {#endpoints}

### Endpoints Utilisateur {#endpoints-utilisateurs}

### Endpoints Produit {#endpoints-produits}

IDs de Titres dans les Articles Académiques

Les articles académiques peuvent utiliser des IDs de titres pour créer des citations et des renvois :

# Méthodologie de Recherche {#methodologie}

Comme montré dans les [Résultats de Recherche](#resultats), notre méthode fonctionne bien dans plusieurs cas de test.

...

# Résultats de Recherche {#resultats}

Cette section présente les résultats expérimentaux décrits dans notre [Méthodologie de Recherche](#methodologie).

Solutions aux Problèmes Courants

IDs de Titres Non Fonctionnels

Si vos IDs de titres ne fonctionnent pas :

1. Vérifiez si la plateforme prend en charge les IDs personnalisés
2. Confirmez que la syntaxe est correcte (généralement {#id})
3. Vérifiez que l'ID ne contient pas de caractères invalides
4. Essayez un autre processeur Markdown

Conflits d'ID

Si plusieurs IDs identiques existent dans le même document, cela peut causer des comportements de lien imprévisibles :

## Problème {#probleme} <!-- Premier ID -->

...

## Problèmes Courants {#probleme} <!-- ID dupliqué, peut causer des problèmes -->

Solution pour éviter les conflits d'ID :

## Problème {#description-probleme}

...

## Problèmes Courants {#problemes-courants}

Espaces et Caractères Spéciaux

Certains processeurs Markdown gèrent différemment les espaces et caractères spéciaux dans les IDs :

<!-- Peut poser problème sur certaines plateformes -->
## Paramètres Avancés {#parametres avances}

<!-- Approche plus sûre -->
## Paramètres Avancés {#parametres-avances}

Syntaxe Connexe

• Liens - Syntaxe de base des liens
• Table des Matières - Génération automatique de sommaire
• Notes de bas de page - Ajouter des références et explications

Outils et Plugins

Table des Matières Automatique

De nombreux outils peuvent générer automatiquement une table des matières à partir des titres et IDs :

[[toc]]

# Chapitre 1 {#chapitre-1}

## Section 1.1 {#section-1-1}

# Chapitre 2 {#chapitre-2}

Outils de Vérification d'ID de Titre

• markdownlint : Peut être configuré pour vérifier la cohérence des IDs de titre
• remark-lint : Fournit la vérification et la correction automatique des IDs de titre
• markdown-toc : Génère automatiquement une table des matières avec liens

---

Les IDs de titres sont un outil important pour améliorer l'utilisabilité et l'accessibilité des documents Markdown. En utilisant des IDs standardisés, vous pouvez créer des structures de liens stables qui facilitent la navigation et la référence, rendant vos documents plus professionnels et conviviaux.