lightning-talk
v4.1.1
Published
Show an SVG drawing as slides
Downloads
7
Readme
lightning-talk
Display an SVG drawing as slides.
Deploy them easily as a static site.
INSTALLATION
npm install [--global] lightning-talk
SYNOPSIS
lightning-talk [--port=<port>] [--open | --open=<executable>]
[--inject-html=<HTML to inject>]
lightning-talk --no-serve
lightning-talk --help
DESCRIPTION
First, we’ll create an index.html
file in your current working directory (that’s where your slides.svg
should be). We do this so that you can deploy your slides as a static site easily.
Second, we’ll spawn a static HTTP server at <port>
(8080 by default). You can opt out of the server by passing --no-serve
.
Pass --open
if you want us to open the presentation in your default browser as soon as it’s up and running. Otherwise, just navigate to http://localhost:8080 and talk!
PREPARING YOUR TALK
Put a
slides.svg
in a directory. This directory is where you’ll runlightning-talk
later.Make sure that:
- Every slide is at least a 1920 × 1080 px rectangle.
- The first one starts at 0, 0.
- Every next slide is 2000 px below the previous one.
We use parametric-svg to allow animations and interactive stuff. During your talk you can increment the parameter
layer
with the flick of a button. It starts at0
and gets reset to0
whenever you change a slide. Feel free to use it how you want.If you need custom HTML to display, say, a video background, this is your go-to option. Pass any HTML (including JS) through this option – we’ll add it right at the beginning of the
<body>
.
DURING YOUR TALK
Make sure you use a modern browser (
fetch
API, arrow functions,Proxy
). Chrome v49+ and Firefox v40+ have it all.Press F to send your talk into fullscreen mode.
Hit PAGE DOWN, → or scroll down to view the next slide. Hit PAGE UP, ← or scroll up to view the previous slide.
LEFT CLICK or ↓ to increment the layer. RIGHT CLICK or ↑ to decrement the layer.
RESPONSIVITY
All we do is scale and center each slide on the screen. So feel free to use the space between your slides to make them look good on screens of any proportions. Wherever there’s no content, we display a black background.
Just be sure to view your presentation in landscape mode. Slides are guaranteed not to overlap then.
LICENSE
MIT © Tomek Wiszniewski and Studio B12