Guide Markdown
Le contenu des pages est rédigé en Markdown. C’est une manière de mettre en forme du texte à l'aide d'une syntaxe simple et intuitive. Ce guide vous apprendra les bases de Markdown en quelques minutes.
Ce guide d’apprenstissage du markdown publié sous licence Creative Commons By-SA 4.0 est adapté la documentation de flus . Nous l’avons enrichi et modifié pour vous permettre d’exploiter au mieux les possibilités offertes par Plateau numériques en terme de mise en forme de vos contenus.
Style du texte : italique, gras, barré
Vous pouvez utiliser _ ou * autour d’un mot pour le mettre en italique. Mettez-en deux pour le mettre en gras.
_italique_ s’affiche ainsi : italique
**gras** s’affiche ainsi : gras
**_gras-italique_** s’affiche ainsi : gras-italique
~~barré~~ s’affiche ainsi : barré
Sous-titres
Les titres se font en commençant une ligne par un #. Ajoutez jusqu’à 6 # pour faire des titres moins importants (on parle aussi de niveau de titre) :
# Titre principal de niveau 1 (h1)
## Sous-titre de niveau 2 (h2)
### Sous-titre de niveau 3 (h3)
#### Sous-titre de niveau 4 (h4)
##### Sous-titre de niveau 5 (h5)
###### Sous-titre de niveau 6 (h6)
Attention : le titre principal h1 de votre page est défini au sein du champs Titre title de l’en-tête, et est rendu automatiquement en haut de page. Pour des raisons d’accessibilité, il est déconseillé d’utiliser plus d’un titre principal par page, vous ne devez donc jamais utiliser de titres de niveau 1 au sein du contenu de vos pages. Utilisez uniquement des sous-titres de niveau 2 à 6 (la plupart du temps, des sous-titre de niveau 2 et 3 suffisent à structurer convenablement votre contenu).
Paragraphes
Les paragraphes se forment naturellement dès que vous séparez deux lignes de texte par une ligne vide.
Si vous souhaitez simplement revenir à la ligne (et générer un saut à la ligne),
il suffit de revenir simplement à la ligne comme ceci en tappant Maj ⇧ + Entrée ↵.
Listes
Vous pouvez créer des listes en commençant une ligne avec les caractères - ou * pour des listes non ordonnées, ou avec des nombres pour des listes ordonnées.
Liste non ordonnée
- un élément
- un autre
- un sous élément
- un autre sous élément
- un dernier élément
- un élément
- un autre
- un sous élément
- un autre sous élément
- un dernier élément
Liste ordonnée
1. élément un
2. élément deux
3. élément trois
- élément un
- élément deux
- élément trois
Liens
URL
Créez un lien en mettant le texte désiré entre crochets et le lien associé entre parenthèses.
Apprenez Markdown avec [ce guide](https://docs.plateaux-numeriques.fr/administrer-le-contenu/guide-markdown/).
s’affiche :
Apprenez Markdown avec ce guide .
Fichiers
De la même façon, vous pouvez créer des liens des fichiers (.pdf, .odt, etc.).
Téléchargez les [status de Plateaux numériques](/media/PN-Statuts.pdf).
s’affiche :
Téléchargez les status de Plateaux numériques .
Images
Sans légende
Affichez une image en plaçant un texte alternatif entre crochets (qui sera affiché si l’image n’apparaît pas) et son adresse entre parenthèses (finissant par .jpg, .png, .gif, .svg, .webp, etc.). Le format est très similaire aux liens, mais le tout doit être précédé d’un ! :
s’affiche :
Il est important de préciser un texte alternatif pour décrire les images porteuses de sens : c’est ce texte qui sera lu à haute voix aux personnes utilisant un lecteur d’écran !
Avec légende
Pour ajouter une légende, ajoutez simplement du texte entre guillement " à la suite de l’url de l’image.
s’affiche :
Citations
Les citations se font avec le signe > :
> La route est longue mais la voie est libre…
s’affiche :
La route est longue mais la voie est libre…
Tableaux
Pour créer un tableau vous devez placer une ligne de tirets - sous la ligne d’entête et séparer les colonnes avec des |. Vous pouvez aussi préciser l’alignement en utilisant des : :
| Aligné à gauche | Centré | Aligné à droite |
|:-----------------|:---------------:| ---------------:|
| Ce texte | ce texte | Ce texte |
| est aligné | est | est aligné |
| à gauche | centré | à droite |
| Aligné à gauche | Centré | Aligné à droite |
|---|---|---|
| Ce texte | ce texte | Ce texte |
| est aligné | est | est aligné |
| à gauche | centré | à droite |
Lignes horizontales
Pour ajouter un séparateur horizontal, ajoutez 3 tirets --- ou 3 astérisques ***.
Comme ceci
Code
Placez du code dans du texte en plaçant le code entre accents graves ` :
Ceci est du `code`.
s’affiche :
Ceci est du code.
Créez un bloc de code en indentant chaque ligne avec quatre espaces, ou en mettant trois accents graves sur la ligne au-dessus et en dessous de votre code. Par exemple :
```
bloc de code
```
s’affiche :
bloc de code
Notes de bas de page
Vous pouvez également ajouter des notes de bas de page comme ceci.[^1]
Attention simplement à bien les numéroter si vous en utilisez plusieurs.[^2]
[^1]: Première note de base de page
[^2]: Seconde note de base de page
s’affiche :
Vous pouvez également ajouter des notes de bas de page comme ceci.1
Attention simplement à bien les numéroter si vous en utilisez plusieurs.2