thor/reveal-hugo
1
0
Fork 0
mirror of https://github.com/Threnklyn/reveal-hugo.git synced 2026-05-18 21:03:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add information about offline dev & file:// URLs

Browse Source
This commit is contained in:
Josh Dzielak
2019-01-26 18:37:10 +01:00
committed by GitHub
parent 7767261ddf
commit 86ab78d189
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -1
View File
@@ -304,7 +304,7 @@ Customize the Reveal.js presentation by setting these values in `config.toml` or
- `reveal_hugo.custom_theme`: The path to a locally hosted Reveal.js theme in the static 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 `https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0`. For local development, change this to point to a file in the static directory.
- `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.
This is how parameters will look in your `config.toml`:
@@ -374,6 +374,17 @@ This is the recommended way to add custom CSS and JavaScript to each presentatio
> - body.html
> - end.html
## Offline development
Offline-friendly development is the default. The Reveal.js and Highlight.js files are loaded from the static directory by default. (See above for how to use a CDN instead). If you need `file:///` URLs to work, make sure to set `relativeURLs` and `uglyURLs` in your `config.toml`.
```toml
relativeURLs = true
uglyURLs = true
```
Note: `uglyURLs` isn't strictly required, but it is useful if you're loading against the filesystem as it makes sure that all URLs end in .html and links point directly at them instead of to a folder.
## Recipes
### Add a Reveal.js presentation to an existing Hugo site