10 conseils pour de meilleures tableaux Markdown
Les tableaux peuvent être délicats en Markdown. Apprenez des conseils d'expert pour créer des tableaux propres, alignés et responsives qui s'affichent parfaitement partout.
Jacky
Les tableaux Markdown semblent simples, mais ils recèlent de nombreux pièges. Ces dix conseils vous aideront à rédiger des tableaux lisibles en format brut et beaux une fois affichés.
1. Alignez les colonnes pour la lisibilité
Même si l'alignement n'affecte pas le rendu, un source aligné est plus facile à maintenir :
| Name | Age | City |
|---------|-----|-------------|
| Alice | 30 | New York |
| Bob | 25 | London |
| Charlie | 35 | Tokyo |
2. Contrôlez l'alignement du texte
Utilisez des deux-points dans la ligne de séparation pour contrôler l'alignement des colonnes :
| Left | Center | Right |
|:-------|:------:|-------:|
| text | text | text |
| 1 | 2 | 3 |
:---= aligné à gauche (par défaut):---:= centré---:= aligné à droite
3. Alignez les nombres à droite
Les nombres sont beaucoup plus faciles à parcourir lorsqu'ils sont alignés à droite :
| Product | Price | Quantity |
|---------|-------:|---------:|
| Apple | $1.99 | 150 |
| Banana | $0.79 | 300 |
4. Utilisez du code en ligne pour les valeurs techniques
Encadrez les chaînes techniques avec des backticks pour les distinguer du texte ordinaire :
| Key | Type | Example |
|---------|-----------|-------------|
| `host` | `string` | `localhost` |
| `port` | `number` | `3000` |
5. Gardez le contenu des cellules concis
Les tableaux ne sont pas des paragraphes. Si une cellule nécessite plus d'environ 10 mots, envisagez un autre format (liste de définitions, liste numérotée ou texte en prose).
6. Utilisez les emojis avec parcimonie pour les colonnes de statut
Les indicateurs de statut bénéficient de marqueurs visuels :
| Feature | Status |
|----------------|--------|
| Authentication | ✅ |
| Dark mode | ✅ |
| Mobile app | 🚧 |
| API v2 | ❌ |
7. Échappez les caractères pipe
Besoin d'un | littéral dans une cellule ? Échappez-le avec une barre oblique inverse :
| Expression | Meaning |
|------------|------------------|
| `a \| b` | a OR b |
| `a & b` | a AND b |
8. Contournement pour le contenu multi-lignes
Les tableaux ne prennent pas en charge les sauts de ligne nativement. Utilisez <br> pour les cellules multi-lignes lorsque c'est pris en charge :
| Name | Notes |
|-------|--------------------------------|
| Alice | Line one<br>Line two |
9. Générez des tableaux complexes avec des outils
Pour les grands tableaux, ne les écrivez pas à la main. Utilisez :
- Tables Generator pour l'édition visuelle
- Des exports de tableurs au format Markdown
- Des outils CLI comme
csv2md
10. Testez le rendu dans votre plateforme cible
Le rendu des tableaux varie selon les plateformes. Vérifiez toujours l'apparence de votre tableau dans l'environnement cible réel — GitHub, GitBook, votre site de documentation — avant de finaliser.