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.
- Git
- NodeJS (l'utilisation de nvm est fortement conseillée)
- Ruby (l'utilisation de rvm est également conseillée)
- Compass
Pour installer l'ensemble des dépendances du projet :
npm install;
bower install;
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
.
À 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.