Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/dzello/reveal-hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordzello <jdzielak@gmail.com>2019-02-02 19:43:31 +0300
committerdzello <jdzielak@gmail.com>2019-02-02 19:43:31 +0300
commit0fb03952d96a9627aa9102ac5b6931a7b85b4e5b (patch)
tree9d7db691bc67c60e1f1732ae10ecf7e4bfe62615 /README.md
parent385dc827567c599317e095d14a432ee473106cdd (diff)
Document custom_theme_compile in the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index 69574e9..93bf2b6 100644
--- a/README.md
+++ b/README.md
@@ -301,7 +301,8 @@ You can use all the additional slide shortcode attributes. They will be applied
Customize the Reveal.js presentation by setting these values in `config.toml` or the front matter of any presentation's `_index.md` file.
- `reveal_hugo.theme`: The Reveal.js theme used; defaults to "black"
-- `reveal_hugo.custom_theme`: The path to a locally hosted Reveal.js theme in the static folder
+- `reveal_hugo.custom_theme`: The path to a locally hosted Reveal.js theme in the static or assets folder
+- `reveal_hugo.custom_theme_compile`: If set to true, the theme will be compiled with Hugo pipes (and must live in the assets folder)
- `reveal_hugo.highlight_theme`: The [highlight.js](https://highlightjs.org/) theme used; defaults to "default"
- `reveal_hugo.reveal_cdn`: The location to load Reveal.js files from; defaults to the `reveal-js` folder in the static directory to support offline development. To load from a CDN instead, set this value to `https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.7.0` or whatever CDN you prefer.
- `reveal_hugo.highlight_cdn`: The location to load highlight.js files from; defaults to to the `highlight-js` folder in the static directory to support offline development. To load from a CDN instead, set this value to `https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0` or whatever CDN you prefer.