Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Slides

View demo

Usage

Create Slides

Copy your markup or markdown slides into /slides.

Pandoc converts between markup formats and can convert to Reveal.js markup from various markup sources.

Features

  • ctrl + click to zoom
  • Render math equations
  • s to view speaker notes
  • ctrl + shift + F to search slide content
  • open the shortcut help menu with shift + ?
  • highlighted code syntax
  • select from various slide and highlight themes
  • hover over the top right of the window to sign in with GitHub and sync notes (for authorized presenters only)
    • participants may sync with the presenter or view slides at their own volition (no authentication required)
  • syncing also allows presenters to use a separate device to control slides

Setup

Frontmatter

key type default description
title string [filename] A title for meta information in the <head />
description string A description for meta information in the <head />
draft boolean false Used to omit compiling
theme string 'black' A stock Reveal.js theme. View available theme names in themes.json
highlightTheme string 'agate' A stock Highlight.js theme. View available theme names in themes.json
reveal object Reveal.js options. View available options. By default, all plugins are already available.

Other values may be included but will be ignored except for in the aggregated frontmatter JSON in build/feed.json.

Config

Create a new config and modify default values of the app

cp example.env .env

Firebase

Create a Google Firebase project. Add Firebase config values to .env in order to use slide sync

Add this ruleset to Realtime Database rules where xxxxx is your Firebase user UID

{
  "rules": {
    "presentations": {
      ".read": true,
      ".write": "auth.uid === 'xxxxx'"
    }
  }
}