Convention
Convention d'écriture des documents
Typographie
Italique
L'italique est utilisé pour définir:
- un champ, une option (case à cocher ou radio button)
- un bouton
- un nom de serveur
- un nom d'utilisateur
- un paquet à installer
- url
- adresse IP
Gras
Le gras est utilisé pour définir:
- le titre d'une fenêtre
- le nom d'un produit ou d'un service (Mariadb, AWS)
Font monospace
Est utilisé pour:
- un nom de fichier ou un répertoire
- une commande à taper
- les sorties de commandes
- le contenu d'un fichier
Admonition
Note
!!! note
This is a note
Note
This is a note
!!! note "Titre personalisé"
This is a note
Titre personalisé
This is a note
Tip
!!! tip
15% if the service is good.
|Example|
|:------|
|line 1 |
|line 2 |
Tip
15% if the service is good.
| Example |
|---|
| line 1 |
| line 2 |
Attention
!!! attention
Directives at large.
Attention
Directives at large.
Danger
!!! danger
Mad scientist at work!
Danger
Mad scientist at work!