prskr/goveal
1
0
Fork 0
Code Issues 1 Pull requests 2 Projects Releases 7 Packages 1 Wiki Activity Actions

Update Readme

Browse source
This commit is contained in:
Peter 2021-11-12 13:14:12 +01:00
parent e8d6de4d3c
commit 565e199f33
Signed by: prskr
GPG key ID: C1DB5D2E8DB512F9
1 changed files with 31 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -2,13 +2,28 @@
[![Actions Status](https://github.com/baez90/goveal/workflows/Go/badge.svg)](https://github.com/baez90/goveal/actions) [![Actions Status](https://github.com/baez90/goveal/workflows/Go/badge.svg)](https://github.com/baez90/goveal/actions)
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. Goveal is very small and very simple tool that reads Markdown from a given file, renders it into a HTML template and
Right now Goveal uses Reveal.js 4.0.2 to create presentations and therefore also includes all features of Reveal.js 4.0.2. serves it as local HTTP server. Right now Goveal uses Reveal.js 4.1.2 to create presentations and therefore also
includes all features of Reveal.js 4.1.2.
## Install
The easiest and fastest way to install Goveal is to use a pre-built binary from the [releases](https://github.com/baez90/goveal/releases/latest).
If you have Go in the latest version installed you can also install it like so:
```bash
// latest and greatest
go install github.com/baez90/goveal@latest
// release
go install github.com/baez90/goveal@v0.0.7
```
_Note: Releases before v0.0.7 are based on Go 1.15 and used Pkger to embed Reveal.JS and cannot be installed with `go install`._
## Usage ## Usage
The easiest way to use `goveal` is to download a release, and run it from your `$PATH`.
```bash ```bash
goveal serve ./slides.md goveal serve ./slides.md
``` ```
@ -28,19 +43,23 @@ goveal serve ./slides.md
## Config ## Config
Goveal supports multiple configuration mechanisms. Goveal supports multiple configuration mechanisms. It tries to load a configuration file from `$HOME` or from `.`
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. 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? :wink:). Most options that can be set via commandline flags can also be set via configuration file (actually all but
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. the `--config` switch does not make sense in the configuration file, does it? :wink:). 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! 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`](./examples/goveal.yaml). See also an example at [`./examples/goveal.yaml`](./examples/goveal.yaml).
### Custom CSS ### Custom CSS
To add custom CSS as theme overrides use a config file and add the `stylesheets` property. To add custom CSS as theme overrides use a config file and add the `stylesheets` property. It takes a list of relative (
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. 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`](./examples/goveal.yaml) also contains a sample how to add custom CSS. the sample configuration file [`./examples/goveal.yaml`](./examples/goveal.yaml) also contains a sample how to add
custom CSS.