diff --git a/README.md b/README.md index 5f2dc488e9fa8c587e903bb508524cc24b577c53..1de7c49c99a5efffd8bfede3b81e8eb0713bdb3e 100644 --- a/README.md +++ b/README.md @@ -5,55 +5,12 @@ [reveal.js](https://github.com/hakimel/reveal.js) est un framework pour construire des présentations HTML. -- Un navigateur est suffisant pour l'afficher. -- Contenu écrit en HTML et/ou en [Markdown](https://fr.wikipedia.org/wiki/Markdown) -- Ce n'est pas WYSIWIG. - -## pandoc - -[pandoc](https://pandoc.org/) est un convertisseur de document d'un language -de markup vers un autre. - -En l'occurence, il peut être utilisé pour générer le contenu d'une [présentation -reveal.js](https://pandoc.org/MANUAL.html#producing-slide-shows-with-pandoc) -à partir de fichiers [Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown). +- Un navigateur est suffisant pour l'afficher. +- Contenu écrit en HTML et/ou en [Markdown](https://fr.wikipedia.org/wiki/Markdown) +- Ce n'est pas WYSIWIG. ## [pole-is/tools/reveal.js](https://gitlab.irstea.fr/pole-is/tools/reveal.js) Fournit : -- une version de reveal.js intégrant un thème INRAE (circa 2020), -- des scripts basés sur le système de construction [Please](https://please.build/), -- de la configuration pour générer automatiquement les présentations avbec Gitlab-CI, - voire les publier automatiquement avec Gitlab-Pages. - -# Utilisation - -## En local (Linux) - -- [Installez Please](https://please.build/quickstart.html) -- Créez un dossier pour votre présentation. -- Installez-y le script de build Please [sample.BUILD](sample.BUILD) et renommez le en `BUILD` -- Créez un dossier pour le contenu de votre présentation, e.g. `ma_presentation` (éditez - le fichier BUILD si vous changez le nom du répertoire) avec un fichier pour les slides `index.md`. - -Vous pouvez en suite créer votre présentation: - -```bash -plz build :ma_presentation -``` - -## Avec intégration continue - -# Sous le capot - -## Outils - -- Please: https://please.build - -Les outils suivants sont téléchargés et vérifiés automatiquement par Please : - -- reveal.js: https://github.com/hakimel/reveal.js -- dart-sass: https://github.com/sass/dart-sass -- minify: https://github.com/tdewolff/minify -- pandoc: https://github.com/jgm/pandoc +- une version de reveal.js intégrant un thème INRAE (circa 2020),