205 lines
6.1 KiB
Markdown
205 lines
6.1 KiB
Markdown
# reveal-hugo
|
|
|
|
A Hugo theme for [Reveal.js](https://revealjs.com/) that allows you to have multiple slides per markdown file. With it, you can turn any of your Hugo content into a presentation by adding `Reveal` to its output formats.
|
|
|
|
|
|
|
|
The motivation behind creating this theme is pretty simple - I didn't want to have to manage one markdown file for every slide, which would add the overhead of coming up with a file name, setting a `weight` param in the front matter to keep it in order, etc, all for just a few lines of text. Instead, I like to organize groups of slides into a smaller number of markdown files, each representing a section of the presentation.
|
|
|
|
### Example
|
|
|
|
Using reveal-hugo, a three-slide (or n-slide) presentation can be created with just one markdown file, like so:
|
|
|
|
```markdown
|
|
# English
|
|
Hello.
|
|
|
|
---
|
|
|
|
# Français
|
|
Salu.
|
|
|
|
---
|
|
|
|
# Espagñol
|
|
Hola.
|
|
```
|
|
|
|
The only requirement is to demarcate slides with `---` surrounded by newlines.
|
|
|
|
## Demo
|
|
|
|
Visit [https://dzello.com/reveal-hugo/](https://dzello.com/reveal-hugo/) to see a presentation created with this theme. You can also check out this exact repository [deployed to Netlify](https://reveal-hugo.netlify.com/).
|
|
|
|
## Usage
|
|
|
|
### Create your first presentation
|
|
|
|
To start, [install Hugo](https://gohugo.io/) and create a new Hugo site:
|
|
|
|
```shell
|
|
$ hugo new site my-presentation
|
|
```
|
|
|
|
Change into the directory of the new site:
|
|
|
|
```shell
|
|
$ cd my-presentation
|
|
```
|
|
|
|
Clone the reveal-hugo theme into the themes directory:
|
|
|
|
```shell
|
|
$ git clone git@github.com:dzello/reveal-hugo.git themes/reveal-hugo
|
|
```
|
|
|
|
Open `config.toml` and add the following contents:
|
|
|
|
```toml
|
|
theme = "reveal-hugo"
|
|
|
|
[outputFormats.Reveal]
|
|
baseName = "index"
|
|
mediaType = "text/html"
|
|
isHTML = true
|
|
```
|
|
This tells Hugo to use the reveal-hugo theme and it registers a new output format called "Reveal".
|
|
|
|
Next, create a file in `content/_index.md` and add the following:
|
|
|
|
```markdown
|
|
+++
|
|
title = "My presentation"
|
|
outputs = ["Reveal"]
|
|
+++
|
|
|
|
# Hello world!
|
|
|
|
This is my first slide.
|
|
```
|
|
|
|
Back on the command line, run:
|
|
|
|
```shell
|
|
$ hugo server
|
|
```
|
|
|
|
Navigate to [http://localhost:1313/](http://localhost:1313/) and you should see your presentation.
|
|
|
|
|
|
|
|
To add more slides, just add content to `_index.md` or create new markdown files in `content/home`. Remember that each slide must be separated by `---` with blank lines above and below.
|
|
|
|
```markdown
|
|
# Hello world!
|
|
|
|
This is my first slide.
|
|
|
|
---
|
|
|
|
# Hello Mars!
|
|
|
|
This is my second slide.
|
|
```
|
|
|
|
### Create a root presentation
|
|
|
|
To create a presentation that lives at the site root, create a `content/_index.md` file and specify that the `Reveal` output format should be used in the front matter:
|
|
|
|
```toml
|
|
outputs = ["Reveal"]
|
|
```
|
|
|
|
Content for this presentation can come from `_index.md`, files in the `home` directory, or any content file whose type is set to `home` in the front matter.
|
|
|
|
Use the `weight` param in the front matter to specify the order that content from these files should appear in the presentation, knowing that content from `_index.md` will always come first.
|
|
|
|
```toml
|
|
weight = 20
|
|
```
|
|
|
|
### Create a section presentation
|
|
|
|
To create a presentation for the content of any section of your Hugo site, just add `Reveal` to its list of `outputFormats` in the front matter of `section/_index.md`:
|
|
|
|
```toml
|
|
outputs = ["Reveal"]
|
|
```
|
|
|
|
Section presentations will include content from each file in that section. Again, use the `weight` param to order the sections, knowing that any content in `_index.md` will come first.
|
|
|
|
Presentations can use a different Reveal.js theme by specifying the `reveal_theme` parameter in the front matter of the section's `_index.md` file.
|
|
|
|
```toml
|
|
reveal_theme = "moon"
|
|
```
|
|
|
|
### Add a Reveal.js presentation to an existing Hugo site
|
|
|
|
If your Hugo site already has a theme but you'd like to create a presentation from some of its content, that's very easy. First, manually copy a few files out of this theme into a few of your site's directories:
|
|
|
|
```shell
|
|
$ cd my-hugo-site
|
|
$ git clone git@github.com:dzello/reveal-hugo.git themes/reveal-hugo
|
|
$ cp -r themes/reveal-hugo/static/reveal static/reveal
|
|
$ cp themes/reveal-hugo/layouts/_default/*.reveal.html layouts/_default
|
|
$ cp themes/reveal-hugo/layouts/shortcodes/* layouts/shortcodes
|
|
$ cp themes/reveal-hugo/layouts/partials/* layouts/partials
|
|
```
|
|
|
|
Next, add the Reveal output format to your site's `config.toml` file
|
|
|
|
```toml
|
|
[outputFormats.Reveal]
|
|
baseName = "index"
|
|
mediaType = "text/html"
|
|
isHTML = true
|
|
```
|
|
|
|
Now you can add `outputs = ["Reveal"]` to the front matter of any section's `_index.md` file and that section's content will be combined into a presentation and written to `index.html`. If you already have a `index.html` page for that section, just change the `baseName` above to `reveal` and the presentation will be placed in a `reveal.html` file instead.
|
|
|
|
Note: If you specify `outputs = ["Reveal"]` for a single content file, you can prevent anything being generated for that file. This is handy if you other default layouts that would have created a regular HTML file from it. Only the list file is required for the presentation.
|
|
|
|
## Features
|
|
|
|
### Fragments
|
|
|
|
Fragments are a Reveal.js concept that lets you introduce content into each slide incrementally. Borrowing the idea from [hugo-theme-revealjs](https://github.com/RealOrangeOne/hugo-theme-revealjs) (thanks!), you can use a `fragment` shortcode to accomplish this in reveal-hugo in the same way.
|
|
|
|
```markdown
|
|
# Let's count to three...
|
|
{{% fragment %}} One {{% /fragment %}}
|
|
{{% fragment %}} Two {{% /fragment %}}
|
|
{{% fragment %}} Three {{% /fragment %}}
|
|
```
|
|
|
|
### Sections
|
|
|
|
Add sections of vertical slides to your presentation by surrounding the relevant slides with the `section` shortcode.
|
|
|
|
```markdown
|
|
{{% section %}}
|
|
|
|
# Section slide 1
|
|
|
|
---
|
|
|
|
# Section slide 2
|
|
|
|
{{% /section %}}
|
|
```
|
|
|
|
### Configuration params
|
|
|
|
These settings go in `config.toml`:
|
|
|
|
- `params.reveal_theme`: The Reveal.js theme used, defaults to "black"
|
|
|
|
# Contributing
|
|
|
|
Contributions are very welcome. To run the example site in this respository locally, clone this repository and run:
|
|
|
|
```shell
|
|
hugo server -s exampleSite -d ../public --themesDir '../' --theme '.'
|
|
```
|
|
|