03-comment-je-travaille/tutos/markdown/tutos-markdown-08-structurer-un-doc.md

Tuto Markdown 08 - Structurer un doc

Public visé: dev lambda.

Objectif

  • Organiser un document pour qu'il reste lisible et navigable.

Références

Exemple

# Guide API

## Sommaire
- [Intro](#intro)
- [Endpoints](#endpoints)

## Intro
Texte d'introduction.

## Endpoints
Liste des routes.

À retenir

  • Les ancres de titres dépendent de l'outil de rendu.
  • Un sommaire manuel suffit pour des docs courtes.
  • Un titre par section aide la navigation.

Exercice

  • Ajoute une section "FAQ" au sommaire et au document.

Assistant documentaire

Posez une question sur la documentation. Les réponses citent leurs sources — un clic ouvre le document à gauche.

Loading…
Loading the web debug toolbar…
Attempt #