2016-03-03 10:58:58 +01:00
## Hacker Slides
2017-05-13 17:40:30 +02:00
[![MIT licensed ](https://img.shields.io/badge/license-MIT-blue.svg )](https://github.com/msoedov/hacker-slides/blob/master/LICENSE)
2016-03-06 20:10:33 +01:00
[![Build Status ](https://travis-ci.org/msoedov/hacker-slides.svg?branch=master )](https://travis-ci.org/msoedov/hacker-slides)
2017-05-13 17:40:30 +02:00
[![ ](https://images.microbadger.com/badges/image/msoedov/hacker-slides:latest.svg )](https://microbadger.com/images/msoedov/hacker-slides "Hacker slides image")
2018-02-19 17:11:12 +01:00
[![Open Source Helpers ](https://www.codetriage.com/msoedov/hacker-slides/badges/users.svg )](https://www.codetriage.com/msoedov/hacker-slides)
2016-03-06 20:10:33 +01:00
2016-03-05 11:15:16 +01:00
This repo is a reworked version of [Sandstorm Hacker Slides ](https://github.com/jacksingleton/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.
2017-05-13 17:40:30 +02:00
#### Features:
- Reach ui editor
- Markdown markup
- Live reload
- Color schemes
- Pdf print
- [Demo version ](https://murmuring-sierra-54081.herokuapp.com )
- Tiny 10 Mb docker image
2017-11-12 23:48:48 +01:00
- Optional Basic auth
2017-05-13 17:40:30 +02:00
2017-05-13 17:23:12 +02:00
2016-03-05 11:15:16 +01:00
| Edit mode | Published |
2018-04-17 00:46:06 +02:00
| --- | --- |
2017-05-13 17:40:30 +02:00
| ![1st ](https://sc-cdn.scaleengine.net/i/520e2f4a8ca107b0263936507120027e.png ) | ![1st ](https://sc-cdn.scaleengine.net/i/7ae0d31a40b0b9e7acc3f131754874cf.png ) |
|![2nd](https://sc-cdn.scaleengine.net/i/5acba66070e24f76bc7f20224adc611e.png) | ![2nd ](https://sc-cdn.scaleengine.net/i/fee3e1374cb13b1d8c292becb7f514ae.png ) |
2016-03-05 11:15:16 +01:00
2016-03-03 11:04:42 +01:00
2017-05-13 17:40:30 +02:00
Run from docker image
-----
```shell
docker run -it -p 8080:8080 -v $(pwd)/slides:/app/slides msoedov/hacker-slides
```
2016-03-03 10:58:58 +01:00
2017-05-13 17:40:30 +02:00
Build locally
----
2016-03-03 10:58:58 +01:00
To build and run it locally
```go
go get
go run main.go
[GIN-debug] Listening and serving HTTP on :8080
```
2016-03-05 11:15:16 +01:00
And then you can just open [http://127.0.0.1:8080 ](http://127.0.0.1:8080 ) and it's ready to use with sample slides.
2016-03-03 10:58:58 +01:00
2017-02-08 02:03:07 +01:00
Run with docker
```shell
2017-11-12 23:48:48 +01:00
docker run -it -p 8080:8080 -v $(pwd)/slides:/app/slides msoedov/hacker-slides
2017-02-08 02:03:07 +01:00
```
2017-11-12 23:57:06 +01:00
Protect slides with password
2017-11-12 23:55:21 +01:00
----
2017-11-12 23:48:48 +01:00
Basic auth (disabled by default)
```shell
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
```
```shell
docker run -it -p 8080:8080 -e USER=bob -e PASSWORD=password1 -v $(pwd)/slides:/app/slides msoedov/hacker-slides
```
2017-02-08 02:03:07 +01:00
2018-02-22 18:34:58 +01:00
Use local images
----
Store pictures you want to use in the images subfolder, slides/images/ and reference them in the editor as Markdown:
```
2018-02-23 11:55:49 +01:00
![demoPicture ](/images/demo.png )
2018-02-22 18:34:58 +01:00
```
or as HTML:
```
2018-02-23 11:55:49 +01:00
< img src = "/images/demo.png" >
2018-02-22 18:34:58 +01:00
```
2016-03-03 10:58:58 +01:00
Getting Help
------------
For **feature requests** and **bug reports** submit an issue
2016-03-03 11:04:42 +01:00
to the GitHub issue tracker