Workshop Materials

The Workshop Materials project provides a simplistic tool for the creation of IT workshop websites with tutorials, articles, and presentations.

Dependencies

The following tools need to be installed before you can start using the tool:

• Hugo
• git

Getting started

To create new workshop materials, you can use the Workshop Materials template:

PROJECT_NAME=your-project-here
{
git clone --recurse \
  https://github.com/experimental-software/workshop-materials-template.git \
  $PROJECT_NAME

cd $PROJECT_NAME
git submodule update --remote
git remote remove origin
}

DEFAULT_BRANCH=main
{
git checkout --orphan $DEFAULT_BRANCH
git add .
git commit -m "Initial commit"
}

Afterwards, refer to the README file of the new project, for hints what should be done next.

Development

This section contains hints for working on the Workshop Materials theme.

Internationalization

The keys for the localizations can be found here: i18n/

In the templates the localizations can be included like this:

{{ i18n "tutorial.back" }}

Credits

• The layout of the start page and the subject list pages is applied from a Bootstrap template by Xiaoying Riley which is licensed under Creative Commons Attribution 3.0 License.
• The layout of the tutorial pages is inspired by Google Codelabs.
• The presentations are based on RevealJS which is licensed under the MIT license.
• At various places of the website Font Awesome icons are used.
• For zooming in images in tutorials, the medium-zoom library from François Chalifour is being used. See license.
• The theme uses Google Fonts, self-hosted with the help of google-webfonts-helper.

Alternative projects

• https://github.com/google/comprehensive-rust

License

MIT