Document custom_theme_compile in main presentation

This commit is contained in:
dzello
2019-02-02 16:41:27 +00:00
parent 5978cc743f
commit 385dc82756
2 changed files with 20 additions and 4 deletions
+16
View File
@@ -30,6 +30,22 @@ custom_theme = "reveal-hugo/themes/robot-lung.css"
---
### Use a custom theme (advanced)
To use Hugo pipes to build a custom Reveal.js theme, place the source file (SCSS / PostCSS) in the `assets` directory and set the `custom_theme_compile` param.
```toml
[params.reveal_hugo]
custom_theme = "reveal-hugo/themes/custom-theme.scss"
custom_theme_compile = true
```
<small>
💡 See the [custom theme example presentation](/custom-theme-example/) for more details.
</small>
---
## Bundled themes
reveal-hugo comes with 2 extra Reveal.js themes:
+4 -4
View File
@@ -35,7 +35,7 @@ Hello world!
---
### Add slides in same file
### Add slides
Separate them by `---`:
@@ -69,13 +69,13 @@ weight = 10
# Slide 4
```
<small>💡 Tip: Use `weight` to specify the order that files should be added.</small>
<small>💡 Tip: Use `weight` to specify the order that files should be considered.</small>
---
### Presentation at '/{section}/'
In `content/{section}/_index.md`:
Add slides to `content/{section}/_index.md`:
```markdown
+++
@@ -105,5 +105,5 @@ weight = 10
# Slide 4
```
<small>💡 Tip: Use `weight` to specify the order that files should be added.</small>
<small>💡 Tip: Use `weight` to specify the order that files should be considered.</small>