Markdown et syntaxe supportée

Référence de la syntaxe Markdown acceptée dans les issues, les pull requests, les commentaires et les fichiers README des dépôts gitrust.

Titres

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

Les titres génèrent des ancres de navigation (ex. #titre-niveau-2).

Mise en forme du texte

Syntaxe	Rendu
`gras`	gras
`italique`	italique
`~~barré~~`	~~barré~~
`code inline`	`code inline`

Blocs de code

Délimiter par trois backticks. Spécifier le langage pour la coloration syntaxique :

```rust
fn main() {
    println!("Hello, gitrust!");
}
```

Langages supportés pour la coloration : rust, go, python, javascript, typescript, json, yaml, toml, bash, sql, html, css, markdown, et la plupart des langages courants.

Listes

Liste non ordonnée

- Premier élément
- Deuxième élément
  - Élément imbriqué

Liste ordonnée

1. Première étape
2. Deuxième étape
3. Troisième étape

Liste de tâches (cases à cocher)

- [x] Tâche accomplie
- [ ] Tâche en attente
- [ ] Autre tâche

Rendu : cases cliquables dans les issues et les PRs. Cocher une case met à jour le texte en temps réel.

Tableaux

| Colonne A | Colonne B | Colonne C |
|-----------|-----------|-----------|
| Valeur 1  | Valeur 2  | Valeur 3  |
| Valeur 4  | Valeur 5  | Valeur 6  |

Alignement des colonnes :

| Gauche | Centre | Droite |
|:-------|:------:|-------:|
| texte  | texte  |  texte |

Liens et images

[Texte du lien](https://example.com)
[Lien relatif](../how-to/gerer-cles-ssh.md)
![Texte alternatif](https://example.com/image.png)

Citations

> Ceci est une citation.
> Elle peut s'étendre sur plusieurs lignes.

Ligne de séparation horizontale

---

Références aux issues et aux PRs

gitrust transforme automatiquement les références en liens cliquables :

Syntaxe	Rendu
`#5`	Lien vers l'issue ou PR numéro 5 du dépôt courant
`owner/repo#5`	Lien vers l'issue 5 d'un autre dépôt

Mentions d'utilisateurs

@tonpseudo

gitrust envoie une notification à l'utilisateur mentionné et crée un lien vers son profil.

Mots-clés de fermeture d'issue

Utilisés dans les messages de commit ou les descriptions de PR pour fermer automatiquement une issue lors de la fusion :

Closes #5
Fixes #12
Resolves #8

Insensibles à la casse. Plusieurs issues peuvent être référencées :

Closes #5, fixes #7

Emojis

La syntaxe :nom_emoji: est supportée :

Syntaxe	Rendu
`:rocket:`	🚀
`:bug:`	🐛
`:white_check_mark:`	✅
`:warning:`	⚠️
`:information_source:`	ℹ️

Labels dans les descriptions

Les labels assignés à une issue sont affichés dans la barre latérale et non directement dans le corps Markdown. Pour référencer un label dans le texte, utilise son nom entre backticks : `bug`.

Diagrammes Mermaid

gitrust supporte les blocs Mermaid dans les README et les wikis (pas dans les commentaires d'issues) :

```mermaid
graph LR
    A[Début] --> B[Étape 1]
    B --> C[Fin]
```

Types supportés : graph, sequenceDiagram, flowchart, stateDiagram-v2, classDiagram, gantt, pie.

Voir aussi

Utiliser les labels et les issues : appliquer les labels et références d'issues
Ouvrir une pull request : rédiger une description de PR efficace

Eric / documentation