hacker-slides

command module
v0.0.0-...-14d9757 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2019 License: MIT Imports: 14 Imported by: 0

README

Hacker Slides

MIT licensed Build Status Open Source Helpers

Hacker Slides is a self hosted reveal.js presentations editor form markdown files.

Features:
  • Reach ui editor
  • Markdown markup
  • Live reload
  • Color schemes
  • Pdf print
  • Demo version
  • Tiny 10 Mb docker image
  • Optional Basic auth
Edit mode Published
1st 1st
2nd 2nd

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.

Run from docker image

docker run -it -p 8080:8080 -v $(pwd)/slides:/app/slides msoedov/hacker-slides

Build locally

To build and run it locally

go get
go run main.go

[GIN-debug] Listening and serving HTTP on :8080

And then you can just open http://127.0.0.1:8080 and it's ready to use with sample slides.

Run with docker

docker run -it -p 8080:8080 -v $(pwd)/slides:/app/slides msoedov/hacker-slides

Protect slides with password

Basic auth (disabled by default)

USER=bob PASSWORD=password1 go run main.go
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:	export GIN_MODE=release
 - using code:	gin.SetMode(gin.ReleaseMode)

WARN[0000] Auth mode enabled
WARN[0000] Visit http://bob:password1@0.0.0.0:8080
docker run -it -p 8080:8080 -e USER=bob -e PASSWORD=password1 -v $(pwd)/slides:/app/slides msoedov/hacker-slides

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">

Getting Help

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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL