Wiki

Auteurices :	flupe, Lapinot
Date d'ajout :	05 Mai 2021
Modifié le :	10 Novembre 2021
	[source]

Le wiki des sbires est généré statiquement à l’aide d’un utilitaire fait maison. Le code source du générateur et l’intégralité du contenu sont hébergés dans le dépot public git.sbi.re/wiki.

Edition du wiki

Pour éditer le contenu du wiki, il suffit de cloner le dépot, modifier localement, puis push sur le serveur — à condition d’avoir les permissions d’édition.

$ git clone git@sbi.re:wiki
$ cd git
...
$ git commit -m "wiki update"
$ git push origin master

Le wiki sera généré sur le serveur automatiquement.

Génération du wiki

Le générateur du wiki est codé en Haskell et utilise la libraire achille. Pour pouvoir générer le wiki en local — et donc voir à quoi ressemblent nos modifications sans faire travailler le serveur — il faut compiler le générateur.

$ cabal install --overwrite-policy=always
$ wiki build

Le générateur est incrémental, regénérer le wiki après avoir édité le contenu est donc a priori très rapide™.

Astuces

Bandeau d’information

Pour afficher un bandeau informatif sur la page d’accueil — en cas de maintenance par exemple — il suffit de modifier content/index.md pour ajouter une valeur dans le champ info des métadonnées :

---
projects:
  - ...
info: |
  Le serveur est en cours de réinstallation, certaines pages
  ne sont peut-être plus d'actualité.
---
...

Après regénération, le bandeau apparaît. Il suffit de supprimer ce champ du fichier pour le faire disparaître à nouveau. Il est de bon ton de préfixer le message d’une date.

Liens internes

Pour l’instant le wiki est assez sommaire. A terme, et une fois qu’il sera un peu plus étoffé, on aimerait appliquer une méthodologie proche de Zettelkasten. Pour insérer un lien vers une autre page du wiki, ne pas utiliser un lien direct https://sbi.re/wiki/... mais préférer le format wiki:.... Le chemin d’un fichier est considéré comme son UID ou identifiant unique. Par exemple, l’UID de la page que vous êtes en train de lire est meta/wiki.

Pour ajouter un lien vers cette page d’ailleurs sur le wiki, on fait donc ainsi :

Pour en apprendre plus, suivre ce [lien](wiki:meta/wiki)

A l’avenir, la syntaxe suivante sera aussi supportée, et ajoutera le titre de la page ciblée comme intitulé du lien.

- [wiki:meta/wiki]
- [wiki:meta/git]