A template for kickstarting Reveal.js presentations and host them on Github Pages.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
presentation
source
.gitignore
README.md
fabfile.py
requirements.txt
source-watcher.sh

README.md

Reveal.js Template

This repository can be used to kickstart Reveal.js presentations and host them on Github Pages.

It also uses Jinja in order to split up the index.html into smaller sub-files (i.e. one file per slide) and it uses Fabric to render your Jinja templates and publish them to Github.

Installation

In order to start a new presentation, do the following:

git clone git@github.com:mbrochh/reveal-template.git
rm -rf .git
git init
git add .
git commit -am "Initial commit"
mkvirtualenv -p python2.7 reveal-template 
workon reveal-template 
pip install -r requirements.txt

Now you should have all necessary Python software installed.

For further convenience you should install observr

Usage

In order to build your presentation you will create and manipulate files in the source folder. If you want to use Jinja templates to split up your presentation, it would be cool to render the template into the presentation folder every time you change something.

In order to run the file system watcher, execute:

./source-watcher.sh

If you don't want to use the file system watcher, you can trigger a build via

fab build

Now make your changes in the source directory. When you are done, review your changes:

fab build
open presentation/index.html

If all looks good, publish to Github:

fab publish

LICENSE

This repository contains the code of Reveal.js which is licensed under the MIT license.