Skip to content
Starter template

Build Carpentries-style lessons 
with Hugo and Hextra

Start new lesson repositories from hugo-styles-template, 
then use this site for the shared module docs, examples, migration help, and update guidance.

Read Quickstart

Start a new lesson

Use the thin template repo for lesson content and branding, then come back here for the shared module docs.

Feature tour

The local example pages exist to demonstrate shared lesson behavior, not to act as the recommended starter content for new repositories.

Further reading

Use the reference page for links to the upstream Hextra and Hugo documentation when you need theme-level or framework-level detail.

Learning Objectives

EpisodeLearning Objectives
Designing a Hugo-first lesson
  • Identify the teaching features that matter more than the old implementation details.
  • Recognise which pieces should live in a shared module versus in a lesson repository.
Using challenge and solution blocks
  • Use challenge, hint, and solution shortcodes in a way that feels natural to authors.
  • Show how learner and instructor context can coexist in the same episode.
Setup choices, profiles, and native embeds
  • Show how profile pages and glossary pages support lesson navigation.
  • Use Hugo-native embed syntax instead of hand-written iframe HTML when a provider shortcode exists.
Physics notation, diagrams, and richer docs
  • Use LaTeX and Mermaid to express analysis logic and notation directly in lesson content.
  • Use Hextra components to keep setup, navigation, and optional depth structured and maintainable.

Schedule

TimeEpisodeQuestions
SetupBefore you start
00:00
Designing a Hugo-first lesson 15 min
  • What should a modern lesson template preserve from the old Carpentries stack?
00:15
Using challenge and solution blocks 25 min
  • How should active-learning blocks behave in a Hugo-based lesson?
00:40
Setup choices, profiles, and native embeds 20 min
  • How do we document setup and learner variation without overloading the main narrative?
01:00
Physics notation, diagrams, and richer docs 30 min
  • How can we communicate a particle-physics analysis workflow clearly without custom frontend code?

Authors and Contributors

ContributorGitHub
Clemens Lange@clelange