No description
Find a file
Peter Kurfer bd27081aa6
Add auto reload
- reload markdown if changed
- allow to monitor other files if wanted
- disable HTTP cache to force reload
- extend example
- replace almost everything with layered file systems
2020-12-04 16:40:08 +01:00
.circleci fix CI 2020-12-02 13:42:12 +01:00
assets Add auto reload 2020-12-04 16:40:08 +01:00
cmd/goveal Update to Reveal 4.0 2020-08-13 09:03:48 +02:00
examples Add auto reload 2020-12-04 16:40:08 +01:00
internal/app Add auto reload 2020-12-04 16:40:08 +01:00
.gitignore Add auto reload 2020-12-04 16:40:08 +01:00
.goreleaser.yml Add auto reload 2020-12-04 16:40:08 +01:00
go.mod Add auto reload 2020-12-04 16:40:08 +01:00
go.sum Add auto reload 2020-12-04 16:40:08 +01:00
LICENSE Initial commit 2019-04-19 14:29:55 +02:00
Makefile Update to Reveal 4.0 2020-08-13 09:03:48 +02:00
pkger_hack.go Add auto reload 2020-12-04 16:40:08 +01:00
README.md Update to Reveal 4.0 2020-08-13 09:03:48 +02:00
Taskfile.yml Add auto reload 2020-12-04 16:40:08 +01:00

Goveal

CircleCI

Goveal is very small an very simple tool that reads Markdown from a given file, renders it into a HTML template and serves it as local HTTP server. Right now Goveal uses Reveal.js 4.0.2 to create presentations and therefore also includes all features of Reveal.js 4.0.2.

Usage

The easiest way to use goveal is to download a release, and run it from your $PATH.

goveal serve ./slides.md
Param Description Default value
--host Hostname the binary is listening on localhost
--port Port the binary is listening on 2233
--code-theme highlight.js theme to use monokai
--transition Transition effect to show between slides none
--navigationMode Navigation mode to use when using the cursor keys to navigate through slides default
--config Path to the config file see config $HOME/goveal:./goveal
--horizontal-separator horizontal separator to split slides ===
--vertical-separator vertical separator to split slides ---
--theme reveal.js theme to use white
-h / --help shows help

Config

Goveal supports multiple configuration mechanisms. It tries to load a configuration file from $HOME or from . i.e. $HOME/goveal.yaml or $HOME/goveal.yml or ./goveal.yaml and so on.

Most options that can be set via commandline flags can also be set via configuration file (actually all but the --config switch does not make sense in the configuration file, does it? 😉). It is more a convenience feature to be able to set a theme and so on and so forth for the presentation without having to pass it every time as parameter.

Furthermore goveal supports configuration hot reloading i.e. you can play around with different themes and the rendered theme will be changed whenever you hit the save button!

See also an example at ./examples/goveal.yaml.

Custom CSS

To add custom CSS as theme overrides use a config file and add the stylesheets property. It takes a list of relative (mandatory!) paths to CSS files that are included automatacally after the page was loaded so that they really overload everything added by Reveal and plugins.

the sample configuration file ./examples/goveal.yaml also contains a sample how to add custom CSS.