archgalileu/hugo-revealjs-generator

Hugo Reveal.js Generator

Simple presentation generator with hugo and reveal.js.

An example is here. https://tanstaafl.0pt.jp/slides/

How to use

1. Install hugo command.
2. Create your workspace.

$ mkdir your-work-space && hugo new site your-work-space

3. Install this theme.

$ cd your-work-space
$ git clone https://github.com/minoritea/hugo-revealjs-generator themes/revealjs

4. Add your first presentation.

$ hugo new your-presentation-name/slide1.md
$ hugo new your-presentation-name/slide2.md
$ hugo new your-presentation-name/slide3.md
# ...

Note that your slides are sorted by title(e.g. slide1 > slide2 > slide3 ...).

5. edit your slides.

• put your contents into slides in hugo's Markdown format.

5.1. You can preview your slides on your computer.

$ hugo server -D -t revealjs # default URL is http://localhost:1313/

6. Generate pages.

• don't forget to set draft as false in TOML headers in markdown files before publish them.

$ hugo -t revealjs

7. Put generated contents(in public directory) into your web site.

How to set a theme to a slides page.

1. download revealjs themes to static/css/theme (some themes are already included).
2. edit data/themes.toml.

["the title of your presentation(converted to lowercase, and singularized)"]
theme = "the file name of the theme you want(without `.css` suffix)"

LISENCE

MIT LISENCE

Note: hugo and reveal.js have their own LISENCE.