From 95bac7c1441ad3afe9a6f844598b4c7cd80d45fb Mon Sep 17 00:00:00 2001 From: dzello Date: Thu, 26 Apr 2018 16:43:52 -0700 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fc87d75..4069a0a 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Visit [https://reveal-hugo.netlify.com/](https://reveal-hugo.netlify.com/) to se # Usage -To create the presentation, the theme will look for all Hugo pages that have a type of `reveal`. That means they're in a `reveal` directory in the `content` folder OR the type is manually set to `reveal` in the front matter. +To create the default presentation (the one that will live at the site root), the theme will look for all Hugo pages that have a type of `reveal`. That means they're in a `reveal` directory in the `content` folder OR the type is manually set to `reveal` in the front matter. ```toml type = 'reveal' @@ -45,6 +45,10 @@ Use the `weight` param in the front matter to specify the order that the pages s weight = 20 ``` +### Section presentations + +To create more than one presentation per repository, organize the content into sections. Section presentations will include content from each file in that section. Again, use the `weight` param to order the sections. + ### Fragments Fragments are a Reveal.js concept that lets you introduce content into each slide incrementally. Borrowing the concept from [hugo-theme-revealjs](https://github.com/RealOrangeOne/hugo-theme-revealjs), you can use a `fragment` shortcode to accomplish this in reveal-hugo in the same way.