gh-reveal

Slides with reveal.js & Jekyll for Github Pages.

Yet Another, why ?

Inspired by

§fragment:1§; But

  • §fragment:1§; not fully compatible with GitHub Pages
  • §fragment:1§; only for one presentation
  • §fragment:1§; not simple to use reveal.js power

What’s new ?

  • Write your presentation with markdown, online on GitHub or offline
  • Use simples keywords to start new slide or configure your slides
  • Customize Reveal.js with YAML Front Matter
  • One repository to store all your presentations

Keywords

Start new slide with PARAGRAPHnew

Keywords

Start new vertical slide with PARAGRAPHbreak

Keywords

Write notes with PARAGRAPHnotes

Press the S key to try it out.

Keywords

Customize slide id with PARAGRAPHid:SLIDE_IDPARAGRAPH;

PARAGRAPHid:id_commandPARAGRAPH;

§id:id_command§;

Keywords

Customize a slide with PARAGRAPHslide:ATTRIBUTES§;

PARAGRAPHslide: data-background=#38F247 PARAGRAPH;

§slide: data-background=#38F247 §;

Keywords

Customize an element with PARAGRAPHelement:ATTRIBUTES§;

- regular element
- leaning element PRAGRAPHelement:style=-ms-transform:rotate(7deg);-webkit-transform:rotate(7deg);transform:rotate(7deg);PARAGRAPH;
- regular element
  • regular element
  • leaning element §element:style=-ms-transform:rotate(7deg);-webkit-transform:rotate(7deg);transform:rotate(7deg);§;
  • regular element

Keywords

Create fragments with PARAGRAPHfragment or PARAGRAPHfragment:NPARAGRAPH; where N is the display order.

Combine with PARAGRAPHelement:class=growPARAGRAPH; to control the fragments style

- element 2 PARAGRAPHfragment:2PARAGRAPH; PARAGRAPHelement:class=growPARAGRAPH;
- element 1 PARAGRAPHfragment:1PARAGRAPH;
- element 3 PARAGRAPHfragment:3PARAGRAPH;
  • element 2 §fragment:2§; §element:class=grow§;
  • element 1 §fragment:1§;
  • element 3 §fragment:3§;

Configuration

All options listed in the README of reveal.js can be set in the YAML Front Matter, attribute initialization

---
title: gh-reveal
subtitle: Slides with Reveal.js & Jekyll for GitHub Pages.
theme: sky
initialization:
  slideNumber: c/t
  transition: concave
---

Theme

Choose your theme in the YAML Front Matter, attribute theme.

Theming

Keyboard shorcuts

  • S : speaker view (with notes)
  • B : break the presentation
  • F : fullscreen
  • ESC : slide overview
  • Ctrl+P : print

And

All the features of reveal.js (I hope…)

Share

Check gh-reveal, multi-presentations with @revealjs & @jekyllrb for Github Pages

https://github.com/tcoupin/gh-reveal via @thibbojunior

Click to tweet

tcoupin/gh-reveal @thibbojunior tcoupin.github.io