Update README.md
This commit is contained in:
parent
0e79c0d110
commit
95bac7c144
1 changed files with 5 additions and 1 deletions
|
@ -33,7 +33,7 @@ Visit [https://reveal-hugo.netlify.com/](https://reveal-hugo.netlify.com/) to se
|
||||||
|
|
||||||
# Usage
|
# 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
|
```toml
|
||||||
type = 'reveal'
|
type = 'reveal'
|
||||||
|
@ -45,6 +45,10 @@ Use the `weight` param in the front matter to specify the order that the pages s
|
||||||
weight = 20
|
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
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
Loading…
Reference in a new issue