Reveal-Jekyll

✨ Web presentation with Markdown, Reveal.js and Jekyll

Demo Download

Reveal.js Web presentation served with jekyll. Find all the reveal.js documentation the default plugins are already package in reveal jekyll. If you have any request, problems please open an issue. Feel free to implement any change and open through pull requests. 😉

Set up

Make sure to install bundle which will ease the installation of jekyll:

gem install bundle
bundle install

Run the presentation ()it zill be one localhost:4000 using

bundle exec jekyll serve

Create your presentation

Raw Markdown

Take a look at the example, In index.html use the layout: raw and then you can create your slides directly in the file using markdown:

___: Makes a basement slide
---: Makes the next slide

One file slides example

Your index.html could look like:

---
layout: raw
---

## First slide
---
## Second slide
___
Second slide's basement
---
## Third slide

Using Jekyll capabilities

Take a look at the example slides and basements, In index.html use the layout: presentation. It will use the _slides and _basements folder to create the presentation.

Slide

Use the _slides folder to create a file per slide in markdown.


---
background: ...                 # Optional to put an image or a color as the background
video: "http://video-link.mp4"  # Optional to put a video as the background
transition: slide               # Optional change the transition type for this slide
---

Slide content in markdown

Don't forget to add the two ---.

To order the presentation you can do something like 01-First-slide-title.md, 02-Second-slide-title.md.

Basement slides

Basement slides can be put in the _basements folder.

The Basement slides will be accessible using the down arrow when on a particular slide. They are connected by the slide attribute which is the filename of the slide.

They are the sub sections of your presentation:


---
slide: slide-title
---
 
Content of the Basement slide in markdown

e.g:

For a slide called 02-slide.md
The basement of that slide 02-1-basement.md should have the attribute slide: 02-slide

Config

Configure Reveal.js in teh _config.yml:

reveal:
  transition: "slide" # none/fade/slide/convex/concave/zoom
  theme: "black" # beige/blood/league/moon/night/serif/simple/sky/solarized/white

You can set globally the transitions and theme of your presentation.

Export presentation

To export the presentation use ?print-pdf at the end of the url to be able to save the page as PDF:

<url>:<port>/<base url>/?print-pdf

Try it at .../Reveal-Jekyll/?print-pdf

Use as a gem

There is a Dockerfile available, check it out to see how to use the theme in a Docker. Basically you need 4 things to make it work as a gem:

The Gemfile with the reveal-jekyll gem: gem 'reveal-jekyll' (specify the version with , '~> 0.0.2')
The index.html which is the entrypoint of your jekyll site and presentation (with explained above configuration)
The _config.yml which defines your theme configuration.
The presentation, assets and content you want to display.

And that's it you'd be good to roll!

License

Reveal Jekyll

Reveal Jekyll MIT licensed

Reveal.js

Reveal.js MIT licensed

Jekyll

Jekyll MIT licensed