updates docs

Author: davidovich

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 public
 exampleSite/resources/_gen
+.hugo_build.lock

README.md

@@ -430,8 +430,8 @@ theme = "moon"
 # the following supposes that menu is accessible in static dir
 [[params.reveal_hugo.plugins]]
 # Name the plugin. This should be the same name used to register a reveal-js plugin,
-# for example RevealMenu, RevealNotes
-name = RevealMenu
+# for example: `RevealMenu`, `RevealNotes`
+name = "RevealMenu"
 source = "menu/menu.js"
 css = "menu/menu.css"
 # verbatim = true # should the css and source paths be used as-is ?

exampleSite/content/highlightjs-linenumbers-example/_index.md

@@ -1,5 +1,5 @@
 +++
-title = "Reveal.js 3.9.0 highlighting example"
+title = "Reveal.js highlighting example"
 outputs = ["Reveal"]
 
 [reveal_hugo]
@@ -11,7 +11,7 @@ highlight_theme = "vs"
 
 ---
 
-This presentation shows the use of the [new highlighting features](https://github.com/hakimel/reveal.js/blob/master/README.md#step-by-step-highlights) which were introduced with Reveal.js [v3.9.0](https://github.com/hakimel/reveal.js/releases/tag/3.9.0).
+This presentation shows the use of the [new highlighting features](https://revealjs.com/code/) which were introduced with Reveal.js [v3.9.0](https://github.com/hakimel/reveal.js/releases/tag/3.9.0).
 
 ---
 
@@ -50,7 +50,7 @@ highlight_theme = "github"
 
 The line highlighting is configured by adding `{}` immediately after the language selection of the markdown code block.
 
-{{< highlight md >}}  
+{{< highlight md >}}
 ```foo{}
 
 ```
@@ -62,7 +62,7 @@ The line highlighting is configured by adding `{}` immediately after the languag
 
 `{}`
 
-{{< highlight md >}}  
+{{< highlight md >}}
 ```go{}
 package main
 import "fmt"
@@ -71,7 +71,7 @@ func main() {
 }
 ```
 {{< /highlight >}}
-   
+
 ```go{}
 package main
 import "fmt"
@@ -130,7 +130,7 @@ func main() {
 
 ## Hiding the line numbers
 
-There is no Reveal.js parameter to use line highlighting *without* line numbers. 
+There is no Reveal.js parameter to use line highlighting *without* line numbers.
 However it can be achieved by adding the some [custom CSS](https://github.com/dzello/reveal-hugo#adding-html-to-the-layout).
 
 {{< highlight html "style=github" >}}
@@ -157,4 +157,4 @@ layouts/partials/{presentation-name}/reveal-hugo/body.html
 
 ---
 
-Thanks!
+Thanks!

exampleSite/content/home/configuration.md

@@ -10,7 +10,7 @@ Place configuration values in `config.toml` or a presentation's front matter (`_
 
 ## Reveal.js themes
 
-Themes control the look and feel of your presentation. Set the `theme` param to any [valid Reveal.js theme](https://github.com/hakimel/reveal.js/#theming).
+Themes control the look and feel of your presentation. Set the `theme` param to any [valid Reveal.js theme](https://revealjs.com/themes/).
 
 ```toml
 [params.reveal_hugo]

exampleSite/content/home/features.md

@@ -4,7 +4,7 @@ weight = 10
 
 ## What's included?
 
-- All Reveal.js HTML, CSS and JS (v3.9.2)
+- All Reveal.js HTML, CSS and JS (v4.4.0)
 - All out-of-the-box Reveal.js themes
 - Two custom Reveal.js themes (including this one)
 

exampleSite/content/hugo-hl-example/_index.md

@@ -26,9 +26,9 @@ You can enable it using the `highlight` shortcode.
 {{</* highlight go */>}}
 
 package main
- 
+
 import "fmt"
- 
+
 func main() {
     fmt.Println("Hello world!")
 }
@@ -44,9 +44,9 @@ Several options are supported, check [Hugo's documentation](https://gohugo.io/co
 {{</* highlight go "style=github,linenos=inline,hl_lines=6" */>}}
 
 package main
- 
+
 import "fmt"
- 
+
 func main() {
     fmt.Println("Hello world!")
 }
@@ -56,7 +56,7 @@ func main() {
 
 ---
 
-You can also use Hugo's highlighter in markdown code fences, 
+You can also use Hugo's highlighter in markdown code fences,
 by putting this in `config.toml`:
 
 {{< highlight toml "style=github" >}}
@@ -77,19 +77,19 @@ style = "github"
 
 {{< highlight go >}}
 package main
- 
+
 import "fmt"
- 
+
 func main() {
     fmt.Println("Hello world!")
 }
 {{< / highlight >}}
 
 ```go
 package main
- 
+
 import "fmt"
- 
+
 func main() {
     fmt.Println("Hello world!")
 }
@@ -107,7 +107,11 @@ If you don't need highlight.js at all, you can prevent it from loading.
 
 [params.reveal_hugo]
 load_default_plugins = false
-plugins = [
-  "reveal-js/plugin/zoom-js/zoom.js",
-  "reveal-js/plugin/notes/notes.js",
-]
+
+[[params.reveal_hugo.plugins]]
+name = "RevealZoom"
+source = "reveal-js/plugin/zoom-js/zoom.js"
+
+[[params.reveal_hugo.plugins]]
+name = "RevealNotes"
+source = "reveal-js/plugin/notes/notes.js"

exampleSite/content/plugin-example/_index.md

@@ -13,7 +13,7 @@ margin = 0.2
 # New plugin object form; reveal-hugo
 # will load your css for you
 [[reveal_hugo.plugins]]
-name = "gallery"
+name = "Gallery"
 source = "plugin/gallery/gallery.plugin.js"
 css = "plugin/gallery/gallery.css"
 
@@ -63,7 +63,7 @@ See the [revealjs-simple-gallery GitHub repo](https://github.com/marcins/revealj
 
 ---
 
-These were the steps to use this plugin for this reveal-hugo presentation.
+These are the steps to use this plugin for this reveal-hugo presentation.
 
 ---
 
@@ -75,10 +75,13 @@ Copy the plugin CSS and JavaScript into the static directory
 
 ### 2
 
-Add the JavaScript and (optionally css) file path to the `plugins` field in the front matter
+Add the JavaScript (and optionally css) file path to the `plugins` field in the
+front matter
 
 ```toml
 [[reveal_hugo.plugins]]
+# name must match the name by which the plugin is exported
+name = "Gallery"
 source = "plugin/gallery/gallery.plugin.js"
 css = "plugin/gallery/gallery.css"
 ```