Commit 9df2d82d authored by Guillaume Perréal's avatar Guillaume Perréal
Browse files

Mise à jour de la présentation par défaut.

parent af4de418
...@@ -2,6 +2,6 @@ ...@@ -2,6 +2,6 @@
Génération de présentations reveal.js. Génération de présentations reveal.js.
Pour plus de détails : [consulter la présentation de prezbuilder](https://pole-is.gitlab.irstea.page/pole-is/tools/prezbuilder/index.html). Pour plus de détails : [consulter la présentation de prezbuilder](https://pole-is.gitlab.irstea.page/tools/prezbuilder/index.html).
Ou la [version linéaire](src/index.md). Ou la [version textuelle](src/index.md).
...@@ -7,8 +7,8 @@ ...@@ -7,8 +7,8 @@
- Génère des présentations [reveal.js](https://revealjs.com/) à partir de fichiers en markdown. - Génère des présentations [reveal.js](https://revealjs.com/) à partir de fichiers en markdown.
- Utilise le [thème INRAE](https://gitlab.irstea.fr/pole-is/tools/reveal.js). - Utilise le [thème INRAE](https://gitlab.irstea.fr/pole-is/tools/reveal.js).
- Génération de la présentation avec [pandoc](https://pandoc.org/). - Génération de la présentation avec [pandoc](https://pandoc.org/).
- Conversion automatique de graphes créés avec [draw.io](https://app.diagrams.net/). - Conversion automatique de graphes créés avec [draw.io](https://app.diagrams.net/) (optionel).
- Génération d'une version PDF avec [wkhtmltopdf](https://wkhtmltopdf.org/). - Génération d'une version PDF avec [wkhtmltopdf](https://wkhtmltopdf.org/) (optionel).
- Mode "dev" avec rechargement automatique de page. - Mode "dev" avec rechargement automatique de page.
La présentation que vous regardez a été générée avec prezbuilder ! La présentation que vous regardez a été générée avec prezbuilder !
...@@ -19,15 +19,15 @@ La présentation que vous regardez a été générée avec prezbuilder ! ...@@ -19,15 +19,15 @@ La présentation que vous regardez a été générée avec prezbuilder !
Prérequis : Prérequis :
- [drawio-desktop](https://github.com/jgraph/drawio-desktop/releases/latest)
- [node 10+](https://nodejs.org/fr/download/) - [node 10+](https://nodejs.org/fr/download/)
- [pandoc](https://pandoc.org/installing.html) - [pandoc](https://pandoc.org/installing.html)
- [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html) - [drawio-desktop](https://github.com/jgraph/drawio-desktop/releases/latest) (optionel)
- [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html) (optionel)
- gulp-cli (`npm install --global gulp-cli`) - gulp-cli (`npm install --global gulp-cli`)
Récupération des sources : Récupération des sources :
```shell ```bash
sudo npm install --global gulp-cli sudo npm install --global gulp-cli
git clone https://gitlab.irstea.fr/pole-is/tools/prezbuild.git git clone https://gitlab.irstea.fr/pole-is/tools/prezbuild.git
npm install --no-dev npm install --no-dev
...@@ -35,7 +35,13 @@ npm install --no-dev ...@@ -35,7 +35,13 @@ npm install --no-dev
## Avec Docker ## Avec Docker
_A venir._ L'image gitlab-registry.irstea.fr/pole-is/tools/prezbuilder:master contient une version présinstalée
de prezbuilder **mais sans drawio**.
```bash
docker login gitlab-registry.irstea.fr
docker pull gitlab-registry.irstea.fr/pole-is/tools/prezbuilder:master
```
## Avec Gitlab Pages ## Avec Gitlab Pages
...@@ -46,15 +52,19 @@ _A venir._ ...@@ -46,15 +52,19 @@ _A venir._
prezbuild crée une (ou plusieurs) présentation(s) dans `public/` à partir du prezbuild crée une (ou plusieurs) présentation(s) dans `public/` à partir du
contenu du répertoire `src/`. contenu du répertoire `src/`.
Chaque présentation est écrite sous la forme d'un fichier au format Markdown
nommés `index.md`. Il est possible d'ajouter des images aux formats PNG, JPG, GIF ou SVG à référencer
depuis le fichier markdown.
## Organisation des fichiers ## Organisation des fichiers
Le répertoire `src/` est parcouru récursivement, et les fichiers sont traités comme suit : Le répertoire `src/` est parcouru récursivement, et les fichiers sont traités comme suit :
- Les fichiers `index.md` sont convertis en présentation `index.html`. - Les fichiers `index.md` sont convertis en présentation `index.html`.
- Les fichiers `.png`, `.jpg`, `.gif` et `.svg` sont copiés tels quels. - Les fichiers `.png`, `.jpg`, `.gif` et `.svg` sont copiés tels quels.
- Les fichiers `.drawio` sont convertis en fichiers `.svg`. - _Optionel:_ les fichiers `.drawio` sont convertis en fichiers `.svg`.
- S'il n'y a pas de fichier `index.md` à la racine, un index des présentations est généré. - S'il n'y a pas de fichier `index.md` à la racine, un index des présentations est généré.
- Un fichier `.pdf` est généré par fichier `index.md`, avec le nom du répetoire parent (en sortie). - _Optionel:_ un fichier `.pdf` est généré par fichier `index.md`, avec le nom du répetoire parent (en sortie).
## Exemple ## Exemple
...@@ -98,33 +108,46 @@ public\ ...@@ -98,33 +108,46 @@ public\
</div> </div>
## Exécution # Exécution
prezbuiler peut être exécuté selon deux modes :
- `build` : une seule exécution.
- pour produire les fichiers de la présentation.
- `dev` : mode serveur avec live-reload,
- présentation accessible sur http://localhost:3000,
- mise à jour automatique sur modification des sources.
## A partir des sources
### A partir des sources: #### Build
Exécution unique : bash
```shell ```bash
gulp build gulp build
``` ```
Mode développement : #### Dev
```shell ```bash
gulp dev gulp dev
``` ```
En mode développement, une première génération est effectuée, puis ## Avec Docker
un serveur web local est lancé -- l'adresse s'affichera dans le terminal.
Les fichiers sont régénérés automatiquement lorsque les ficheirs sources sont #### Build
modifiés, et si tout va bien, la présentation est rechargée automatiquement.
Il faut mapper les répertoires /src et /public sur vos sources et le répertoire de sortie :
```bash
docker run --rm -t --init -u $(id -u):$(id -g) -v $PWD/src:/src:ro -v $PWD/public:/public gitlab-registry.irstea.fr/pole-is/tools/prezbuilder:master build
``` ```
[...]
[17:54:38] Starting 'serve'... #### Dev
[17:54:38] Starting 'watch_prez'...
[17:54:38] Starting 'watch_assets'... Il faut également mapper les ports 3000 et 35729 :
[17:54:38] Starting 'watch_graphs'...
[17:54:38] Starting 'watch_pdf'... ```bash
[17:54:38] Webserver started at http://localhost:3000 docker run --rm -t --init -u $(id -u):$(id -g) -v $PWD/src:/src:ro -p 3000:3000 -p 35729:35729 gitlab-registry.irstea.fr/pole-is/tools/prezbuilder:master
``` ```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment