Mémo de syntaxe¶
Page de référence pour la rédaction des supports. Chaque élément est présenté d'abord en source, puis dans son rendu réel juste en dessous.
Cette page n'est pas listée dans la navigation : elle reste accessible par son URL mais n'apparaît pas dans la barre latérale.
Titres¶
# Titre de la page (un seul par fichier, tout en haut)
## Grande partie
### Étape
#### Sous-étape (n'apparaît pas dans le sommaire, `toc_depth: 3`)
Les niveaux changent la taille du texte, pas sa marge gauche. La hiérarchie se voit dans le sommaire de droite, pas dans le corps de la page.
Emphase et code court¶
Du texte **en gras**, *en italique*, et une commande `systemctl status`.
On peut aussi ==surligner== et indiquer une touche : ++ctrl+c++
Du texte en gras, en italique, et une commande systemctl status.
On peut aussi indiquer une combinaison de touches : ++ctrl+c++
Listes¶
- Premier point
- Deuxième point
- Sous-point (quatre espaces)
1. Première étape
2. Deuxième étape
- [ ] Tâche à faire
- [x] Tâche terminée
- Premier point
-
Deuxième point
- Sous-point
-
Première étape
-
Deuxième étape
-
[ ] Tâche à faire
- [x] Tâche terminée
Blocs de code¶
Le langage active la coloration syntaxique. title= affiche un bandeau,
linenums="1" numérote, hl_lines surligne des lignes précises.
```bash title="Sur srv-deb"
apt update
apt install nginx
systemctl enable --now nginx
```
```ini title="/etc/ssh/sshd_config" linenums="1" hl_lines="2 3"
Port 22
PermitRootLogin no
PasswordAuthentication no
```
Encarts¶
Trois points d'exclamation, un type, un titre entre guillemets. Contenu indenté de quatre espaces, ligne vide avant le bloc.
Les types utiles pour des travaux pratiques :
note — information complémentaire
Ce qu'on peut lire ou ignorer sans conséquence.
tip — conseil de méthode
Une bonne pratique, une façon plus rapide de s'y prendre.
warning — attention
Un piège fréquent, une manipulation à ne pas rater.
danger — opération destructrice
Perte de données possible. À réserver aux vraies mises en garde.
example — exemple de sortie attendue
Ce que l'étudiant doit voir à l'écran s'il a réussi.
question — à réfléchir
Une question ouverte, sans réponse dans l'énoncé.
Sans titre après le type, l'encart affiche le nom du type. Avec un titre vide
"", il n'affiche aucun bandeau.
Blocs repliables¶
Trois points d'interrogation au lieu de trois exclamations. C'est l'outil principal pour dispenser de l'aide sans l'imposer.
??? tip "Un indice si vous bloquez"
La commande cherchée liste les unités du gestionnaire de services.
???+ warning "Déplié par défaut, mais refermable"
Utile pour un rappel qu'on veut visible sans qu'il encombre.
Un indice si vous bloquez
La commande cherchée liste les unités du gestionnaire de services. Elle accepte un filtre sur le type d'unité.
Déplié par défaut, mais refermable
Utile pour un rappel qu'on veut visible sans qu'il encombre.
On peut imbriquer pour donner l'aide par paliers, en décalant de quatre espaces supplémentaires à chaque niveau.
Comment savoir quel service occupe le port 80 ?
Cherchez du côté des outils qui listent les sockets en écoute.
Toujours bloqué ?
Il en existe un dans le paquet iproute2, avec une option pour les
processus et une pour l'écoute.
Le contenu n'est pas protégé
Il est présent dans le HTML, seulement masqué. Pour un indice, sans importance. Pour un corrigé, à garder ailleurs.
Onglets¶
L'outil clé pour les contrastes entre familles de distributions.
=== "Debian"
```bash
apt install nginx
systemctl enable --now nginx
```
=== "Rocky Linux"
```bash
dnf install nginx
systemctl enable --now nginx
firewall-cmd --add-service=http --permanent
```
À utiliser avec parcimonie dans les énoncés
Les onglets donnent la commande. Si l'exercice consiste à la trouver, ils la déminent. Réservez-les aux corrigés et aux rappels de cours.
Tableaux¶
| Machine | Système | Rôle |
|---|---|---|
| `poste` | Debian | Poste de travail |
| `srv-deb` | Debian | Serveur famille Debian |
| `srv-rhel` | Rocky Linux | Serveur famille Red Hat |
| Machine | Système | Rôle |
|---|---|---|
poste |
Debian | Poste de travail |
srv-deb |
Debian | Serveur famille Debian |
srv-rhel |
Rocky Linux | Serveur famille Red Hat |
Alignement avec :---, :---: et ---: dans la ligne de séparation.
Schémas¶
Les diagrammes s'écrivent en source, ce qui les rend modifiables et versionnables — contrairement à une image exportée.
Listes de définitions¶
Pratique pour un glossaire ou un rappel de vocabulaire.
Unité
: Objet géré par systemd : service, socket, minuterie, point de montage.
Cible
: Regroupement d'unités correspondant à un état du système.
Unité : Objet géré par systemd : service, socket, minuterie, point de montage.
Cible : Regroupement d'unités correspondant à un état du système.
Liens et images¶
[Lien vers une autre page](administration-systeme/l3/index.md)
[Lien vers une section](#encarts)
[Lien externe](https://www.debian.org)
{ width="400" }
Les liens internes pointent vers le fichier .md, pas vers l'URL finale.
MkDocs les réécrit et signale au build ceux qui sont cassés.
Notes de bas de page¶
Le gestionnaire de paquets diffère selon la famille1.
Citations et séparateurs¶
Une citation, ou un extrait de documentation officielle.
Portabilité¶
Les supports sont publiés sous licence ouverte : quelqu'un doit pouvoir les reprendre ailleurs. Tous les éléments de cette page ne se valent pas de ce point de vue.
| Élément | Hors MkDocs |
|---|---|
| Titres, listes, tableaux, code, liens, citations | Rendu identique partout |
| Notes de bas de page, listes de définitions | Rendu correct sur la plupart des plateformes |
| Encarts, blocs repliables, onglets | Affichés en texte brut, lisibles mais sans mise en forme |
| Mermaid | Rendu par GitLab et GitHub, pas partout ailleurs |
En pratique : le fond d'un énoncé s'écrit avec les éléments de la première ligne. Les encarts et les blocs repliables portent l'aide et les mises en garde — des éléments dont la perte dégrade la présentation sans rendre le document inutilisable.
-
APT chez Debian, DNF chez Red Hat. ↩