Étapes
steps rend une séquence verticale numérotée pour la documentation procédurale. Il est utile lorsque chaque étape a besoin d’un titre et de contenu Markdown complémentaire, comme des paragraphes, des listes, des encadrés ou des blocs de code.
Cette page sert de placeholder pour la référence complète du shortcode. Le shortcode existe déjà dans layouts/shortcodes/steps.html; utilisez-le avec parcimonie lorsqu’une liste ordonnée ordinaire ne suffit pas.
Exemple#
Préparer la page#
Décidez si la procédure a besoin de titres, d’explications ou d’exemples sous chaque étape.
Ajouter le shortcode#
Utilisez les délimiteurs avec pourcentage pour que le Markdown interne soit rendu.
{{% steps %}}
### Titre de l’étape
Détail de l’étape.
{{% /steps %}}Garder un usage procédural#
Utilisez steps pour du travail ordonné. Utilisez une liste normale lorsque les items sont courts.
Manifeste d’interface
- Nature
- Shortcode
- Catégorie
- Contenu
- Statut
- Implémenté
- Implémentation
- Shortcode:
layouts/shortcodes/steps.htmlCSS:assets/css/site.css
Accessibilité#
- Chaque titre d’étape demeure un vrai titre.
- Le numéro visible est généré avec des compteurs CSS et soutient le motif de lecture visuelle.
- N’utilisez pas le composant pour des listes décoratives. L’ordre doit compter.