pkg.gl

Categorygithub.com/bketelsen/slides

modulepackage

0.0.5

Repository: https://github.com/bketelsen/slides.git

Documentation: pkg.go.dev

# README

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 clones https://github.com/bketelsen/slides-template 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.

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