Cheat sheet
Syntaxe basique
| Élément | Syntaxe | Exemple | Rendu |
|---|---|---|---|
| Titres | # à ###### | ###### Titre niveau 6 | Titre niveau 6 |
| Gras | **texte** ou __texte__ | **texte important** | texte important |
| Italique | *texte* ou _texte_ | *texte en italique* | texte en italique |
| Gras et Italique | ***texte*** | ***texte mixte*** | texte mixte |
| Barré | ~~texte~~ | ~~texte barré~~ ` | ~~texte barré~~ |
| Liste non ordonnée | - ou * | - Item 1 <br> -Item 2 | • Item 1 • Item 2 |
| Liste ordonnée | 1. | 1. Premier <br> 1. Second | 1. Premier 2. Second |
| Liste de tâches | - [ ] ou - [x] | - [ ] À faire <br> - [x] Fait | ☐ À faire ✓ Fait |
| Lien | [texte](URL) | [Google](https://google.com) | |
| Image |  |  |  |
| Citation | > | > Ceci est une citation | > Ceci est une citation |
| Bloc de lignes | 4 espaces en début de ligne | exemple | bloc exemple |
| afficher un bloc de markdown sans l'interprété | ```` <br> text <br>```` | ```` <br> exemple <br>```` | <br> exemple <br> |
| Ligne horizontale | --- ou *** | --- | --- |
| Note de bas de page | [^1] et [^1]: | Texte[^1] <br> [^1]: Note | Texte[^1] |
| Code en ligne | `code` | `print("Hello")` | print("Hello") |
| Bloc de code | ```langage``` | Voir section "bloc de code" ci-dessous | Voir section "bloc de code" ci-dessous |
| Tableau | Pipes et tirets | Voir section "tableau avancé" ci-dessous | Tableau formaté |
Bloc de code
Exemple de bloc Python:
```python title="hello_world.py"
def hello_world():
"""Fonction d'exemple"""
print("Hello, World!")
return True
# Appel de la fonction
hello_world()
```
def hello_world():
"""Fonction d'exemple"""
print("Hello, World!")
return True
# Appel de la fonction
hello_world()
Exemple de bloc bash:
rendu:
Note
Support variable : La coloration syntaxique dépend du moteur de rendu Markdown utilisé (GitHub, GitLab, VS Code, etc.)
Alias : Certains langages ont plusieurs noms acceptés (ex: cpp ou c++)
Sans langage : Si vous ne spécifiez pas de langage, le code sera affiché sans coloration
Pour afficher du texte brut : Utilisez text ou plaintext pour désactiver la coloration
Pour ajouter un titre sur un bloc de code, il faut rajouter title="Le titre"
Voici une liste non exhaustive des langages de programmation couramment supportés pour la coloration syntaxique avec les blocs de code en Markdown (triple backticks ```) :
- Langages populaires
| Langage | Mot-clé |
|---|---|
| Python | python, py |
| JavaScript | javascript, js |
| Java | java |
| C | c |
| C++ | cpp, c++ |
| C# | csharp, cs |
| PHP | php |
| Ruby | ruby, rb |
| Go | go, golang |
| Rust | rust, rs |
| Swift | swift |
| Kotlin | kotlin, kt |
| TypeScript | typescript, ts |
| HTML | html |
| CSS | css |
| SQL | sql |
| Bash/Shell | bash, sh, shell |
| Markdown | markdown, md |
| JSON | json |
| XML | xml |
| YAML | yaml, yml |
| Dockerfile | dockerfile, docker |
- Scripting et autres
| Langage | Mot-clé |
|---|---|
| Perl | perl, pl |
| R | r |
| Scala | scala |
| Haskell | haskell, hs |
| Lua | lua |
| PowerShell | powershell, ps, ps1 |
| MATLAB | matlab |
| Julia | julia |
| Groovy | groovy |
| Dart | dart |
- Web et données
| Langage | Mot-clé |
|---|---|
| JSX | jsx |
| TSX | tsx |
| Vue.js | vue |
| SASS/SCSS | scss, sass |
| GraphQL | graphql |
| CSV | csv |
| TOML | toml |
| INI | ini |
- Configuration et autres
| Langage | Mot-clé |
|---|---|
| Makefile | makefile |
| nginx | nginx |
| Apache | apache, htaccess |
| Diff | diff |
| LaTeX | latex, tex |
Tableau avancé
| Langage | Type | Niveau | Popularité |
|---|---|---|---|
| Python | Interprété | Débutant à Expert | ⭐⭐⭐⭐⭐ |
| JavaScript | Interprété | Intermédiaire | ⭐⭐⭐⭐⭐ |
| Java | Compilé | Intermédiaire | ⭐⭐⭐⭐ |
| C++ | Compilé | Avancé | ⭐⭐⭐ |
| SQL | Déclaratif | Tous niveaux | ⭐⭐⭐⭐⭐ |
- Alignement dans les tableaux
| Alignement à gauche | Centré | Alignement à droite |
|:-------------------|:------:|-------------------:|
| Texte gauche | Texte centre | Texte droite |
| Données | Autres données | Chiffres |
Emojs
Les émojis sont supportés : 
(:smile: :thumbsup: :warning:)
Quelques exemples :
* 
pour le déploiement. :rocket:
* 
pour les bugs. :bug:
* 
pour les nouvelles fonctionnalités. :sparkles:
* 
pour la documentation. :memo:
ou
⚠️ Warning: Do not push the big red button.
📝 Note: Sunrises are beautiful.
💡 Tip: Remember to appreciate the little things in life.
Avertissements
Note simple
Note
test de note
Tip
Pour supprimer le titre il faut rajouter "" derrière !!! note, et pour changement le titre "nouveau titre" à la suite de !!! note
Note pliante et dépliante
Note
test de note pliée
Note
test de note dépliée
Types supportés
Note
Note
Ceci est une note
Abstract
Abstract
Ceci est un résumé
Info
Info
Ceci est une info
Tip
Tip
Ceci est une astuce
Success
Success
Ceci est un succès
Question
Question
Ceci est une question
Warning
Warning
Ceci est un warning
Failure
Failure
Ceci est une erreur
Danger
Danger
Ceci est un danger
bug
Bug
Ceci est un bug
Example
Example
Ceci est un exemple
Quote
Quote
Ceci est une citation
Echappement des caractères
Pour afficher les caractères spéciaux sans interprétation :
- Astérisque : \*
- Soulignement : \_
- Accolade : \{
- Crochet : \[
- Parenthèse : \(
- Dièse : \#
- Plus : \+
- Moins : \-
- Point : \.
- Point d'exclamation : \!
Liens et références
<!-- Liens externes -->
[Google](https://www.google.com)
<!-- Liens internes -->
[Aller à la section 1](#1-bloc-de-code)
<!-- Liens avec titre -->
[Markdown Guide](https://www.markdownguide.org "Documentation officielle")
<!-- Références -->
[Wikipedia][1]
[GitHub][2]
[1]: https://wikipedia.org
[2]: https://github.com
Images
<!-- Image basique -->
<!-- Image avec taille -->
<img src="https://markdown-here.com/img/icon256.png" width="100" height="100">
<!-- Image avec lien -->
[](https://markdown-here.com)