GitScrum
Essayer gratuitement

Guide Markdown

GitScrum Studio supporte le formatage Markdown dans les descriptions de tâches, les commentaires, les pages wiki et la documentation. Ce guide couvre toute la syntaxe supportée avec des exemples.

Pourquoi Markdown

Markdown vous permet d'écrire du contenu formaté sans quitter votre clavier. Pas de boutons à cliquer, pas de menus à naviguer. Tapez simplement la syntaxe et voyez le résultat.

Les développeurs utilisent déjà Markdown dans les READMEs, la documentation et les trackers d'issues. GitScrum utilise la même syntaxe que vous connaissez de GitHub.

Formatage de Base

Titres

Créez des titres avec les symboles # :

# Titre 1
## Titre 2
### Titre 3
#### Titre 4

Emphase

*italique* ou _italique_
**gras** ou __gras__
***gras italique*** ou ___gras italique___
~~barré~~

Sauts de Ligne

Terminez une ligne avec deux espaces pour un saut souple. Ou utilisez une ligne vide pour un saut de paragraphe.

Listes

Listes Non Ordonnées

- Élément un
- Élément deux
  - Élément imbriqué
  - Autre imbriqué
- Élément trois

Listes Ordonnées

1. Premier élément
2. Deuxième élément
   1. Numéroté imbriqué
   2. Autre imbriqué
3. Troisième élément

Listes de Tâches

- [ ] Tâche non cochée
- [x] Tâche complétée
- [ ] Autre tâche en attente

Liens et Images

Liens

[Texte du lien](https://exemple.com)
[Lien avec titre](https://exemple.com "Titre au survol")

Images

![Texte alternatif](url-image.png)
![Texte alternatif](url-image.png "Titre de l'image")

Liens de Référence

[Texte du lien][reference]

[reference]: https://exemple.com

Code

Code en Ligne

Utilisez les backticks pour le code en ligne : const x = 42;

Blocs de Code

Utilisez des triples backticks avec un langage optionnel :

function hello(name) {
  return `Bonjour, ${name}!`;
}

Langages supportés pour la coloration syntaxique :

  • javascript, typescript, jsx, tsx
  • python, ruby, php
  • html, css, scss
  • json, yaml, markdown
  • bash, shell
  • sql
  • go, rust, java, c, cpp

Citations

> Ceci est une citation
> s'étendant sur plusieurs lignes

> Citations imbriquées
>> Deuxième niveau
>>> Troisième niveau

Tableaux

| En-tête 1 | En-tête 2 | En-tête 3 |
|-----------|-----------|-----------|
| Cellule 1 | Cellule 2 | Cellule 3 |
| Cellule 4 | Cellule 5 | Cellule 6 |

Alignement :

| Gauche | Centre | Droite |
|:-------|:------:|-------:|
| G      |   C    |      D |

Règles Horizontales

Utilisez trois tirets, astérisques ou underscores ou plus :

---
***
___

Fonctionnalités Spéciales

Mentions

Mentionnez des membres de l'équipe avec @ :

@johndoe veuillez revoir ceci

Références de Tâches

Liez aux tâches avec # :

Lié à #123
Bloque #456

Labels

Référencez les labels avec ~ :

Ajouter le label ~bug
Étiqueté comme ~priority:high

Échapper les Caractères

Utilisez le backslash pour afficher les caractères littéraux :

\*pas en italique\*
\# pas un titre
\[pas un lien\]

Touches du Clavier

Affichez les raccourcis clavier :

Appuyez sur <kbd>Cmd</kbd> + <kbd>K</kbd> pour rechercher

Bonnes Pratiques

Descriptions de Tâches

  • Commencez avec une phrase de résumé claire
  • Utilisez des titres pour organiser les sections
  • Incluez des blocs de code pour les détails techniques
  • Ajoutez des listes de tâches pour les critères d'acceptation

Pages Wiki

  • Utilisez des titres descriptifs pour la navigation
  • Incluez une table des matières pour les longues pages
  • Liez aux pages connexes
  • Mettez à jour la date de modification

Commentaires

  • Gardez ça concis
  • Citez le contexte pertinent
  • Utilisez des blocs de code pour les logs/erreurs
  • Mentionnez les personnes qui doivent le voir

Erreurs Courantes

Pas d'espace après #

❌ #Titre
✅ # Titre

Listes imbriquées cassées

❌ 
- Élément
 - Imbriqué (seulement 1 espace)

✅ 
- Élément
  - Imbriqué (2 espaces)

Blocs de code non fermés Utilisez toujours des triples backticks correspondants.

Mode Aperçu

La plupart des champs de texte dans GitScrum affichent un aperçu pendant que vous tapez. Basculez entre les modes édition et aperçu pour voir le résultat final avant de sauvegarder.

Comment Signaler un Problème ou Demander une Fonctionnalité

Si le markdown ne s'affiche pas correctement ou si vous avez besoin d'un support de syntaxe supplémentaire, soumettez vos commentaires via GitScrum Studio. Dans la barre latérale, cliquez sur Tickets de Support et ouvrez un ticket.

← Previous Next →