Skip to content

Commit

Permalink
Merge pull request #9 from Phlow/master
Browse files Browse the repository at this point in the history
Corrected Date
  • Loading branch information
dploeger authored Mar 23, 2017
2 parents bcdef50 + 6c92b1d commit 0efbb60
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 21 deletions.
28 changes: 10 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@ A Jekyll-based framework for creating presentations based on Reveal.js and markd
## Introduction

If you like [Reveal.js][] for creating your online presentations, like the site
management [Jekyll][] gives you and like [Markdown][] because of its easy and clean look,
here's an easy way to create a presentation using Jekyll, Markdown and Reveal.js.
management [Jekyll][] gives you and like [Markdown][] because of its easy and clean look, here's an easy way to create a presentation using Jekyll, Markdown and Reveal.js.

See the [example presentation][] created using the contents in this repository and "jekyll build".

## Howto

First, [install Jekyll][]. After that, clone this repository and create a branch
for your new presentation:
First, [install Jekyll][]. After that, clone this repository and create a branch for your new presentation:

git clone --recursive https://github.com/dploeger/jekyll-revealjs.git
git checkout -b presentation1
Expand All @@ -23,40 +21,34 @@ Clean the Example presentation:
git rm _posts/*
mkdir _posts

After that, add your slides into the _posts-subdirectory in clean Markdown syntax
and you're ready to go with building your presentation with Jekyll:
After that, add your slides into the _posts-subdirectory in clean Markdown syntax and you're ready to go with building your presentation with Jekyll:

jekyll build

You can even manage multiple presentations using the power of git. Simply branch from the
master branch to create a new presentation:
You can even manage multiple presentations using the power of git. Simply branch from the master branch to create a new presentation:

git checkout master
git branch presentation2
git checkout presentation2

## Slide filenames

Because we're using the Jekyll posts-framework to easily gather the slides for the presentation,
we're bound to the conventions of Jekyll posts, namely being
Because we're using the Jekyll posts-framework to easily gather the slides for the presentation, we're bound to the conventions of Jekyll posts, namely being

<year>-<month>-<day>-<title>.md

We recommend naming the files like

1-1-1-1-welcome.md
1-1-1-2-topics.md
0000-01-01-welcome.md
0000-01-02-topics.md

and so forth.
and so forth.

Jekyll will assume, that each post has been made on the first of january, 2001 (which is of no interest
for a presentation). The additional number is for sorting purposes. After that comes a title to identify
the specific slide (which is actually only for the presentation author, Jekyll doesn't care about it).
Jekyll will assume, that each post has been made on the first of january, 2001 (which is of no interest for a presentation). The additional number is for sorting purposes. After that comes a title to identify the specific slide (which is actually only for the presentation author, Jekyll doesn't care about it).

## Configuring the presentation

You can configure almost any reveal.js setting using the _config.yml-settings file in the
root directory.
You can configure almost any reveal.js setting using the _config.yml-settings file in the root directory.

* title: The title of your presentation (displayed in the browser's title bar)
* reveal_theme: The reveal.js-theme to use [default.css]
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions _posts/1-1-1-2-slides.md → _posts/0000-01-02-slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This is the second slide. And it's just another file inside the _posts-directory.

It is identified as slide 2, because it has a "2" after the mandatory date-part (1-1-1) in its
filename. (It's called 1-1-1-2-slides.md)
It is identified as slide 2, because it has a "2" after the mandatory date-part (0000-01-01) in its
filename. (It's called 0000-01-02-slides.md)

---

This is a third slide, although we're still in 1-1-1-2-slides.md.
This is a third slide, although we're still in 0000-01-02-slides.md.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 0efbb60

Please sign in to comment.