Contexte : règles de rédaction et de mise en forme communes à toutes les pages de la base de connaissances 2S Innovation · Testé sur : Wiki.js 2.5.311, éditeur Markdown · Dernière vérification : 01/10/2026
Ce guide garantit des pages lisibles, fiables et homogènes, quel que soit leur auteur. Il s'applique à toute page créée ou remaniée. Pour démarrer une page, copiez le gabarit adapté depuis le modèle de page, puis relisez-la avec la liste de contrôle qui termine ce guide.
Toutes les pages du wiki sont publiques : chacune peut être lue par n'importe quel visiteur, sans compte. Rédigez chaque page en conséquence, en particulier pour les secrets (voir « Secrets et données sensibles »). Seules la création et la modification des pages sont réservées à l'administrateur.
DOCTYPE, ni de balises html, head, body, style, script ou title.| Classe | Usage |
|---|---|
k-hero |
Bandeau de présentation en tête de la page d'accueil |
k-cards et k-card |
Grille de cartes cliquables vers les sections ou les pages |
k-pill |
Étiquette courte en majuscules, par exemple « NOUVEAU » ou « BASE DE CONNAISSANCES » |
<div class="k-cards">
<a class="k-card" href="/tutos"><strong>Tutoriels</strong><span>Des procédures pas à pas.</span></a>
<a class="k-card" href="/guides"><strong>Guides pratiques</strong><span>Des fiches simples pour le quotidien.</span></a>
</div>
Ne laissez aucune ligne vide à l'intérieur d'un bloc de cartes : une ligne vide termine le bloc HTML et casse l'affichage des cartes suivantes.
Chaque page est rangée dans la section qui correspond à son contenu :
| Chemin | Contenu |
|---|---|
/tutos/<domaine>/<sujet> |
Tutoriels techniques ; domaines : linux, conteneurs, applications, supervision, reseau, windows |
/guides/<sujet> |
Guides pratiques grand public |
/securite/<sujet> |
Sécurité et bonnes pratiques |
/infra/… |
Documentation de l'infrastructure alpha : hôte Proxmox VE, réseau, services, journal |
/projets/… |
Projets et formations (ESGI, BTS SIO, infrastructures de test) |
/archives/<catégorie>/<sujet> |
Pages conservées pour mémoire ; catégories : doublons, fusionnees, obsoletes, specifique-cemea, gabarits-vides, anciennes-intros |
/meta/<sujet> |
Fonctionnement du wiki |
Les chemins sont en minuscules, sans accents ni espaces, avec des mots séparés par des tirets (par exemple /tutos/linux/serveur-dns-bind9). Un chemin doit rester stable : si une page est déplacée, corrigez tous les liens qui pointent vers elle.
#) dans le corps : Wiki.js affiche déjà le titre de la page. Les sections sont en ## (H2), les sous-sections en ### (H3), sans sauter de niveau.Les tutoriels, fiches et guides commencent par un bandeau qui situe le contenu :
> **Contexte :** à quoi sert la procédure · **Testé sur :** Debian 12, Zabbix 7.0 · **Dernière vérification :** 01/10/2026
{.is-info}
| Type de page | Plan |
|---|---|
| Tutoriel | ## Objectif, ## Prérequis, ## Étapes (avec ### 1. …, ### 2. …), ## Vérification, ## Dépannage (si pertinent), ## Références |
| Guide grand public | Même logique, en plus simple : objectif, étapes numérotées et illustrées, références si la page s'inspire d'une source |
| Fiche service (infra) | ## État actuel, ## Accès, ## Exploitation, ## Sécurité, ## Historique |
| Index de section | Courte introduction, puis cartes k-cards ou liste de liens avec une phrase par page |
| Archive | Contenu d'origine inchangé, précédé d'un bandeau d'archive (voir « Pages d'archive et fusions ») |
Adaptez le plan au sujet plutôt que de laisser des sections vides : une section sans objet est supprimée.
bash, shell, powershell, yaml, ini, nginx, sql, json, xml, dockerfile, apache, text…text.bash= ou shell=.```bash
sudo apt update && sudo apt upgrade -y
```
Wiki.js reconnaît une seule syntaxe d'encadré : une citation (>) suivie, sur la ligne suivante, d'une classe entre accolades.
> **Attention :** faites une sauvegarde avant de continuer.
{.is-warning}
Rendu des quatre types :
Information : contexte, rappel ou lien utile.
Succès : résultat attendu d'une étape ou d'une vérification.
Attention : précaution avant une action risquée ou irréversible.
Danger : risque de perte de données, de coupure de service ou de faille de sécurité.
Les pages importées d'autres outils doivent être converties :
| Syntaxe d'origine | Conversion Wiki.js |
|---|---|
:::info … ::: (HedgeDoc), de même pour success, warning et danger |
Citation > … suivie de {.is-info} (ou de la classe correspondante) |
> [!warning] (Obsidian) |
Citation > … suivie de {.is-warning} |
<div class="…"> utilisé comme encadré |
Citation > … suivie de la classe Wiki.js adaptée |
:::spoiler Titre … ::: |
Une sous-section ### ou un bloc <details> |
{%youtube xxx%} |
Lien https://www.youtube.com/watch?v=xxx |
| Front-matter YAML visible en tête de page | À supprimer : titre, description et étiquettes se règlent dans les propriétés de la page |
Emoji en code court (:warning:) |
Emoji Unicode, ou rien |
Toutes les pages sont publiques : aucun secret ne doit figurer dans une page, quelle que soit sa section. Remplacez chaque valeur par un nom générique explicite, en majuscules, entre chevrons :
| Donnée | Valeur générique |
|---|---|
| Mot de passe d'un compte d'administration | <MOT_DE_PASSE_ADMIN> |
| Mot de passe de base de données | <MOT_DE_PASSE_DB> |
| Jeton d'un cluster K3s | <K3S_TOKEN> |
| Clé Wi-Fi | <CLE_WIFI> |
| SID d'un domaine Active Directory | <SID_DOMAINE> |
Sont concernés : mots de passe, jetons, clés d'API et clés privées, clés Wi-Fi, réponses aux questions secrètes, identifiants AnyDesk et SID de domaine réels.
admin, root, Administrateur) peuvent rester.Admin / zabbix pour Zabbix) sont acceptés, avec la mention « à changer immédiatement ».Un secret publié par erreur doit être considéré comme compromis : changez-le sur le système concerné, puis faites purger l'historique de la page, qui conserve les anciennes versions.
192.168.1.X, <IP_SERVEUR>, $VMID), jamais les adresses, VMID ou CTID réels de notre infrastructure. Le lecteur doit pouvoir appliquer la procédure sur son propre réseau sans rien écraser./infra) : utilisez uniquement les valeurs réelles et actuelles, celles de l'inventaire des CT, VM et adresses./, par exemple [Faire un chroot](/tutos/linux/chroot). N'utilisez ni l'adresse complète du wiki, ni le préfixe de langue /fr/, ni un lien vers une page qui n'existe pas.https://, de préférence vers la documentation officielle.## Références, par exemple : « Adapté d'un tutoriel des CEMÉA (tutos.cemea.org) ; images hébergées par la source. »| Écrire | Éviter |
|---|---|
| Proxmox VE | proxmox, ProxMox |
| pfSense | PfSense, PFsense, pfsense |
| Zabbix | zabbix (hors commandes) |
| Nextcloud | NextCloud, nextcloud |
Docker Compose (la commande : docker compose) |
docker-compose, Docker-Compose |
| Wiki.js | WikiJS, wikijs |
| Kubernetes, K3s | kubernetes, k3s (hors commandes) |
| MariaDB, MySQL | mariadb, Mysql |
| Active Directory | active directory |
| Let's Encrypt | letsencrypt, Lets Encrypt |
| Wi-Fi | wifi, WiFi, Wifi |
Chaque page reçoit de 2 à 5 étiquettes, choisies uniquement dans cette liste :
| Domaine | Étiquettes |
|---|---|
| Systèmes | linux, windows, proxmox |
| Réseau et sécurité | reseau, pfsense, securite |
| Conteneurs | docker, kubernetes |
| Applications | applications, nextcloud, zabbix |
| Exploitation | infra, supervision, sauvegarde, haute-disponibilite |
| Usages | guide, bureautique |
| Projets | projet, esgi, bts-sio |
| Cycle de vie | archive, obsolete |
| Wiki et société | meta, 2s-innovation |
<IP_SERVEUR>.$ sur une même ligne peuvent déclencher le rendu mathématique. Écrivez les variables shell en code, par exemple $VMID.:nom: est converti en emoji. Mettez-le en code s'il doit s'afficher tel quel.{.is-…} doit se trouver sur la ligne qui suit immédiatement la citation, sans ligne vide entre les deux.Une page obsolète, en doublon ou fusionnée n'est ni réécrite ni supprimée : elle est déplacée sous /archives, son contenu d'origine est conservé (secrets remplacés) et un bandeau est ajouté tout en haut.
> **Archive** — page conservée pour mémoire, non maintenue. Voir : [Titre de la page à jour](/chemin)
{.is-warning}
Pour une page fusionnée, le texte devient : Cette page a été fusionnée dans [Titre](/chemin). Une page d'archive restée en HTML (éditeur « Code ») utilise l'équivalent suivant :
<blockquote class="is-warning"><p><strong>Archive</strong> — page conservée pour mémoire, non maintenue. Voir : <a href="/chemin">Titre de la page à jour</a></p></blockquote>
Lors d'une fusion, la page cible reprend l'essentiel utile de toutes les sources, sans doublon.
## et sous-sections en ###