bunige-slides/README.md

118 lines
3.2 KiB
Markdown

---
title: BUNIGE slides
subtitle: Un thème BUNIGE pour reveal.js
date: 2026-08-18T14:22:30+0200
id: 20260818142230
tags: ["reveal.js", "slides", "UNIGE", "bibliothèque"]
---
## Description
[BUNIGE slides][1] a pour but d'accélérer la création de slides avec
`reveal.js`, avec un thème à peu près compatible avec la [charte graphique de
l'Université][3] de Genève (UNIGE). BUNIGE est l'acronyme de la [Bibliothèque
de l'UNIGE][2].
## Usage
### Requis
Pour pouvoir utiliser ce projet, les utilitaires suivants doivent être
installés :
- `npm` pour gérer les paquets Node.js, essentiellement pour installer
`reveal.js` et quelques dépendances (Sass, Browsersync).
- `make`.
- `pandoc` pour la conversion des documents.
- `watchexec` pour l'observation des changements dans les fichiers sources
(commande `make watch`).
### Mise en place
Une fois ces outils disponibles, clonez le projet :
```bash
git clone https://git.milhit.ch/igor/bunige-slides.git
```
Naviguer dans le bon dossier et installer les dépendances :
```bash
cd bunige-slides
npm install
```
### Édition
Le principe général est le suivant :
- Édition des *slides* dans un fichier au format Markdown.
- Conversion du fichier Markdown en un fichier HTML qui pourra ensuite être
servi par un serveur web.
Le fichier `slides.md` qui est dans le dossier `sources/slides` donne un bon
aperçu de ce qui peut être réalisé, notamment avec les classes HTML/CSS rendues
disponibles par le thème BUNIGE.
Pour créer une présentation, vous pouvez soit éditer le fichier `slides.md`
soit en créer un autre, dans le même répertoire. Dans ce cas, il faudra
également modifier la ligne suivante du `Makefile` :
```make
SLIDES_FILE = slides.md
```
Il faut remplacer `slides.md` par le nom de votre fichier.
### Construction du fichier HTML
Pour utiliser la présentation, elle doit être au format HTML. La conversion se
fait au moyen de l'utilitaire Pandoc, sur la base de la librairie `reveal.js`
installée dans le projet, et le thème BUNIGE.
Pour lancer la conversion :
```bash
make
```
On peut également lancer une commande pour que la conversion se relance à
chaque fois que les fichiers sources sont modifiés :
```bash
make watch
```
### Prévisualiser le résultat
Pour avoir un aperçu du résultat, il faut servir le fichier HTML par un serveur
web. Vous pouvez utiliser la commande `make serve` (qui utilise Browsersync,
installé dans les dépendances).
En combinant `make watch` et `make serve` dans deux sessions du terminal, on
obtient un environnement pour éditer sa présentation.
### Modifier le thème
Pour modifier le thème, il faut éditer les fichiers suivants :
- `src/scss/bunige.scss`. La compilation du fichier `static/css/bunige.css`
se fait avec la commande `make css`. `make watch-css` pour recompiler à
chaque modification de la source est aussi disponible.
- `static/templates/template.html` est le modèle utilisé par Pandoc et qui
peut contenir une logique sur la base de variables.
### Supprimer les fichiers générés
Pour supprimer les fichiers générés (`index.html` et `bunige.css`) :
```bash
make clean
```
<!-- références -->
[1]: /
[2]: https://www.unige.ch/biblio
[3]: https://www.unige.ch/communication/publier/charte