/decks-template

A node (grunt) project for markdown-based presentation using reveal.js — vNext : switching from JavaScript inclusion of Markdown to Jekyll building of decks.

Primary LanguageCSSMIT LicenseMIT

Decks-template

Ce projet permet de produire, à partir de sources en Markdown, un site statique prêt à l'hébergement, contenant l'ensemble des présentations voulues. Ces présentations sont exportables en PDF.

Prérequis

Installation et utilisation

Pour installer l'ensemble des dépendances du projet :

npm install;
bower install;

Écriture

Pour lancer le site en local avec un jeu de slides de tests, renommez slides_samples en slides puis exécutez :

$ npm run serve

Le site est alors disponible sur http://localhost:9000 et se met à jour au fil des contributions. Pour uniquement compiler sans prévisualiser, exécuter npm run build.

Contribution et organisation des fichiers

À la racine du dossier slides, vous devez placer :

  • un dossier par présentation à compiler ;
  • un fichier list.json décrivant ces présentations.

Dans chaque présentation, vous pouvez organiser vos slides sous la forme de fichiers MarkDown indépendants, à plat ou dans un dossier représentant un défilement vertical. Un fichier list.json, facultatif, vous permet de réorganiser vos slides ou d'en sélectionner une sous-partie si nécessaire.