/reveal-hugo-template

Primary LanguageHTML

RevealJS + Hugo Default Presentation

template to get started quickly with Reveal-Hugo by @dzello

Basics

This template has the following in place from @dzello's Hugo theme:

  1. Installed Hugo and then created a new Hugo site via:
hugo new site my-presentation
cd my-presentation

  1. Initialized the theme as a Hugo module (i.e. hugo mod init github.com/jerdog/reveal-hugo-template)

  2. Declared the Reveal+Hugo theme module as a dependency (i.e. hugo mod get github.com/dzello/reveal-hugo)

  3. Added the basic presentation starter file to /content/_index.md

  4. Added .gitkeep to the base Hugo folders so that the full structure comes over in the repo

Using this template for your presentation(s)

Prerequisites

  1. Make sure you have Hugo installed:

Mac

brew install hugo

Linux

sudo snap install hugo

Windows

choco install hugo-extended
  1. Click Use this template from the top right of the repo and create a new repository

Updates you need to make

  1. Update the go.mod file with the correct location of your GitHub repo:
// update the below to reflect your github repo location
module github.com/jerdog/reveal-hugo-template
  1. Update the Hugo theme module to the latest version:
hugo mod get -u github.com/dzello/reveal-hugo

Documentation

To get up to speed on all other elements and usage of Reveal.js with Hugo, visit @dzello's README