workshop-materials

Hugo theme for building websites for IT workshops with Codelabs-like tutorials and reveal.js presentations

Introduction

Motivation

TBD

Getting started

TBD

Tutorials

Add a new tutorial

Run the following command to add a new presentation in Hugo’s content directory:

hugo new --kind tutorial subject-two/my-tutorial

Content syntax

The presentations can be created using Markdown syntax.

Along with the Markdown syntax, you can use the following custom Hugo shortcodes:

Info callout box

{{< info >}}
Lorem [impsum](https://example.com) dolor sit amet.
{{< /info >}}

Tip callout box

{{< tip >}}
Lorem [impsum](https://example.com) dolor sit amet.
{{< /tip >}}

Warning callout box

{{< warning >}}
Lorem [impsum](https://example.com) dolor sit amet.
{{< /warning >}}

Presentations

Presentation syntax

The presentations can be created using plain HTML with the reveal.js syntax.

Add a new presentation

Run the following command to add a new presentation in Hugo’s content directory:

hugo new --kind presentation subject-two/my-presentation

Advanced

The following section describes advanced, optional features.

THIS FEATURE IS NOT ACTUALLY SUPPORTED YET.

Maybe there could be a search for the page contents.

This needs to be enabled in the config.toml file like this:

enableSearch = true

Before the search is actually available a search index needs to be generated. To generate the search index, Python needs to be installed.

./theme/workshop-materials/tool/create_search_index.sh

Imprint

See experimental-software.com