Skip to main content

Organisation des informations avec des sections réduites

Vous pouvez simplifier votre Markdown en créant une section réduite avec la balise <details>.

Qui peut utiliser cette fonctionnalité ?

Markdown peut ĂȘtre utilisĂ© dans l’interface web GitHub.

CrĂ©ation d’une section rĂ©duite

Vous pouvez masquer temporairement des sections de votre Markdown en crĂ©ant une section rĂ©duite que le lecteur peut choisir de dĂ©velopper. Par exemple, quand vous voulez inclure des dĂ©tails techniques dans un commentaire de problĂšme qui sont susceptibles de ne pas ĂȘtre pertinents ou de ne pas intĂ©resser tous les lecteurs, vous pouvez les placer dans une section rĂ©duite.

Tout Markdown au sein du bloc <details> est rĂ©duit jusqu’à ce que le lecteur clique sur pour dĂ©velopper les dĂ©tails.

Dans le bloc <details>, utilisez la balise <summary> pour informer les lecteurs de ce qui se trouve Ă  l’intĂ©rieur. L’étiquette apparaĂźt Ă  droite de .

<details>

<summary>Tips for collapsed sections</summary>

### You can add a header

You can add text within a collapsed section.

You can add an image or a code block, too.

```ruby
   puts "Hello World"
```

</details>

Le Markdown Ă  l’intĂ©rieur de la balise <summary> est rĂ©duit par dĂ©faut :

Capture d'Ă©cran du Markdown ci-dessus sur cette page tel que rendu sur GitHub, montrant une flĂšche orientĂ©e vers la droite et l'en-tĂȘte « Tips for collapsed sections » (Conseils pour les sections rĂ©duites).

Une fois qu’un lecteur clique sur , les dĂ©tails sont dĂ©veloppĂ©s :

Capture d'Ă©cran du Markdown ci-dessus sur cette page tel que rendu sur GitHub. La section rĂ©duite contient des en-tĂȘtes, du texte, des images et des blocs de code.

Si vous le souhaitez, pour que la section s'affiche ouverte par dĂ©faut, ajoutez l'attribut open Ă  la balise <details> :

<details open>

Pour aller plus loin