mirror of
https://github.com/Threnklyn/reveal-hugo.git
synced 2026-06-05 21:28:28 +02:00
Document how layout extension works
This commit is contained in:
@@ -107,64 +107,3 @@ weight = 10
|
||||
|
||||
<small>💡 Tip: Use `weight` to specify the order that files should be added.</small>
|
||||
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
---
|
||||
|
||||
## Reveal.js themes
|
||||
|
||||
Put in `config.toml` or a presentation's front matter.
|
||||
|
||||
Use the `theme` key for themes that come with Reveal.js.
|
||||
|
||||
```toml
|
||||
[params.reveal_hugo]
|
||||
theme = "moon"
|
||||
highlight_theme = "zenburn"
|
||||
```
|
||||
|
||||
[Reveal.js themes](https://github.com/hakimel/reveal.js/#theming) ·
|
||||
[highlight.js themes](https://highlightjs.org/static/demo/)
|
||||
|
||||
---
|
||||
|
||||
## Use a custom theme
|
||||
|
||||
Use the `custom_theme` key to point to a CSS file in the `static` directory.
|
||||
|
||||
```toml
|
||||
[params.reveal_hugo]
|
||||
custom_theme = "reveal-hugo/themes/robot-lung.css"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Like this theme?
|
||||
|
||||
reveal-hugo comes with 2 extra Reveal.js themes:
|
||||
|
||||
- [robot-lung](https://github.com/dzello/revealjs-themes#robot-lung) (this one)
|
||||
- [sunblind](https://github.com/dzello/revealjs-themes#sunblind)
|
||||
|
||||
<br>
|
||||
<small>
|
||||
They live in the `static/reveal-hugo/themes` folder and also [on Github](https://github.com/dzello/revealjs-themes).
|
||||
</small>
|
||||
|
||||
---
|
||||
|
||||
## Reveal.js params
|
||||
|
||||
Set **snakecase** versions of Reveal.js params, which will be camelized and passed to `Reveal.initialize`.
|
||||
|
||||
```toml
|
||||
[params.reveal_hugo]
|
||||
history = true
|
||||
slide_number = true
|
||||
transition = 'zoom'
|
||||
transition_speed = 'fast'
|
||||
```
|
||||
|
||||
[Full list of params](https://github.com/hakimel/reveal.js/#configuration)
|
||||
|
||||
Reference in New Issue
Block a user