- Posté le
- • 📚 Guides & Procédures
Guide Markdown
- Auteur
-
-
- Utilisateur
- Thibaud
- Billets de cet auteur
- Billets de cet auteur
-
![]()
Markdown est un langage de balisage léger permettant de rédiger du contenu formaté en utilisant une syntaxe simple et lisible.
Il est aujourd'hui largement utilisé pour la prise de notes avec mise en forme rapide dans des applications de bureau de type Joplin, OnlyOffice, etc, mais aussi utilisé sur :
- GitHub
- GitLab
- Nextcloud
- HTMLy
- BookStack
- MkDocs
- Wiki.js
- et bien plus...
Cette liste de syntaxe est adaptée depuis la documentation officielle de Github
Titres
# Titre niveau 1
## Titre niveau 2
### Titre niveau 3
#### Titre niveau 4
Résultat :
Titre niveau 1
Titre niveau 2
Titre niveau 3
Titre niveau 4
Mise en forme du texte
Italique
*Texte en italique*
Résultat :
Texte en italique
Gras
**Texte en gras**
Résultat :
Texte en gras
Gras et italique
***Texte important***
Résultat :
Texte important
Barré
~~Texte supprimé~~
Résultat :
Texte supprimé
Listes
Liste à puces
- Élément 1
- Élément 2
- Élément 3
Résultat :
- Élément 1
- Élément 2
- Élément 3
Liste imbriquée
- Élément 1
- Élément 2
- Sous-élément 2.1
- Sous-élément 2.2
Résultat :
- Élément 1
- Élément 2
- Sous-élément 2.1
- Sous-élément 2.2
Liste numérotée
1. Première étape
2. Deuxième étape
3. Troisième étape
Résultat :
- Première étape
- Deuxième étape
- Troisième étape
Listes de tâches
- [x] Installer Linux
- [x] Configurer Nextcloud
- [ ] Sauvegarder les données
Résultat :
- [x] Installer Linux
- [x] Configurer Nextcloud
- [ ] Sauvegarder les données
Liens
Lien classique
[Site de Circuit Libre](https://circuitlibre.fr)
Résultats :
URL directe
https://circuitlibre.fr
Résultat :
https://circuitlibre.fr
Images
Image simple

Résultat :

Affiche une image avec un texte alternatif.
Image avec titre

Citations
> Ceci est une citation.
Résultat :
Ceci est une citation.
Citation multi-lignes
> Première ligne
> Deuxième ligne
Résultat :
Première ligne Deuxième ligne
Code
Code en ligne
Utilisez la commande `ls -la`.
Résultat :
Utilisez la commande ls -la.
Bloc de code
Un bloc de code doit être entouré de 3 symboles ```, avec le nom du langage utilisé.
Exemple :
```bash
<mon_code>
Colorisation syntaxique
Note : la colorisation syntaxique est effectuée sur cette instance avec Prism.
Exemples de langages supportées
- Bash
ls -lah
sudo apt update
sudo apt upgrade -y
- PHP
<?php
echo "Bonjour";
- Python
def factorielle(n):
if n == 0:
return 1
else:
return n * factorielle(n-1)
print(factorielle(5)) # Affiche 120
- Javascript
console.log("Hello world");
- YAML
services:
nextcloud:
image: nextcloud
- Voir toute la liste des langages supportés.
Bloc de code avec nom du fichier
⚠️ Script js custom
S'emploie en préfixant le bloc de code par {nom.fichier}.
Le nom du fichier sera alors affiché dans un bandeau collé en haut du bloc de code.
{fancyAlert.js}
function fancyAlert(arg) {
if (arg) {
$.facebox({ div: '#foo' })
}
}
Blocs infos
Les blocs d'infos sont normalement utilisés avec :::<balise>, mais pour des raisons de compatibilité avec HTMLy, ils sont utilisés ici avec !!<balise>.
Le principe reste le même :
- Info
!!info
!!
!!info Ceci est une info !!
- Succès
!!success
!!
!!success Ceci est un succès !!
- Avertissement
!!warn
!!
!!warn Ceci est un avertissement !!
- Erreur
!!error
!!
!!error Ceci est une erreur !!
Tableaux
| Logiciel | Type | Licence |
|-----------|--------|----------|
| Linux Mint | Système | Libre |
| Nextcloud | Cloud | Libre |
| Firefox | Navigateur | Libre |
Résultat :
| Logiciel | Type | Licence |
|---|---|---|
| Linux Mint | Système | Libre |
| Nextcloud | Cloud | Libre |
| Firefox | Navigateur | Libre |
Notes de bas de page
Voici une référence[^1].
[^1]: Ma note de bas de page.
Résultat : Voici une référence1.
-
Ma note de bas de page. ↩︎