bketelsen/slides

create, live-preview, edit, and publish reveal.js slide decks

Slides

This repo is a reworked version of Sandstorm Hacker Slides which features easy set up run outside of Sandstorm and without vagrant-spk. Likewise you can publish and edit your previous markdown slides which is not supported in the original version.

Features:

• Reach ui editor
• Markdown markup
• Live reload
• Color schemes
• Pdf print
• Live version

Getting Started

Install from releases: releases coming soon : brew, apt, and friends

Install from Source:

go get github.com/bketelsen/slides

Initialize a New Slide Repository

slides init [reponame]

slides init mytalks
cd mytalks
git init
git add --all

Then edit anything you want to change in publish.tmpl for individual slides and root.tmpl for the talk listing page.

slides init places the contents of the slides-template directory into the mytalks directory as a base for your decks. The web assets in this directory are used to build the HTML files for your slides.

Directory Structure Of a Slide Repository

If you ran slides init mytalks your directory structure should look like this:

/mytalks --> repo root
    /public --> output files from `slides build`, published HTML
    /slides --> your slide decks, in Markdown format
    /static --> files used for `slides dev` local server
    /templates --> Go template files for `/public` and `/static`
    /initial-slides.md --> the template file used for `slides new {name}`

Create New Slide Deck

slides new mydeckname

Run Development Server (With Live Editing!)

slides dev

Visit localhost to see your slides and make live edits.

Prepare for HTML Publishing

slides build

For maximum awesome, run slides build and setup Netlify or another static host to publish your /public directory.

Serve The Published Directory Locally

slides serve

Visit your site at http://127.0.0.1:8080

Use local images

Store pictures you want to use in the images subfolder, slides/images/ and reference them in the editor as Markdown:

![demoPicture](/images/demo.png)

or as HTML:

<img src="/images/demo.png">

Screenshots

Edit mode	Published

Built on Open Source

This project is a heavily modified fork of hacker-slides and is built on the Shoulders of Giants

Getting Help

For feature requests and bug reports submit an issue to the GitHub issue tracker

slides's Issues

link to shoulders.md in readme

Update Readme to credit original Go author of hacker-slides better

License file includes credit, but Readme should have better credit.

add option for company logo in bio

or maybe just link to company's branding site?

add 'slides version' command

The version information is already at the top of slides --help, so this would be a convenience to just print that out. For example:

arschles ~/gocode/src/github.com/bketelsen/slides $ slides version
0.0.2, commit d0f1b81, built at 2018-08-12T16:36:44Z

Update Readme to reflect current state

talk metadata

add a yaml/json/something file for each deck with metadata like:

• event name
• event date
• event url

bio/images

add a bio + images endpoint for conferences to pull images and speaker bio

cute footer

Add a cute "Generated by github.com/bketelsen/slides" footer in the templates

PDF support

add pdf support to the build command
link it in the root.tmpl as a little blue tag in the top?

Put some style in landing page

because seriously, who made this, a developer??

goreleaser

Add goreleaser support.

add `init` command

To create a new repo. Depends on #3

add slides syntax command

slides syntax should print help for slide syntax
depends on #1

add a "slides preview"

make it the same thing as slides dev except you can't edit inline. this would be useful to see how the slides look exactly before you do a final slides build

analytics support

Add Google Analytics and/or piwik support

remove all the stdout output

too much, not needed anymore.

macros

Build in some macros to replace the awful regex for FontAwesome

allow 'slides build' to output to a specific directory

if you could do something like slides build --output public/talks and slides would output to public/talks instead of just public, it could integrate with other static sites

command line help

Add ability to change port

Compile assets into binary

Allow slides to be a stand-alone go install

[Feature Request] - Multiple speaker notes (slides) per single audience slide

Hi there,

To avoid losing your train of thought, finding your place (in speaker note bullet points), and having tiny text (in speaker notes), it would be amazing to be able to do the following:

• create a slide
• have multiple bullet points associated with that slide
• when you advance using the keyboard, display each bullet point individually in the speaker notes.
• once you have cycled through each point, advance the public slide, and the speaker note to the first point (of that next slide)

Please let me know if you need more detail.