Skip to content
This documentation is a live feature demo. See the feature guide.
Troubleshooting

Troubleshooting

The checker reports legacy syntax in a migrated repo

Run the checker on the migrated output and search for:

  • leftover fenced-attribute syntax such as {: .challenge}
  • Liquid includes or variables
  • raw iframe embeds

The checker is designed to catch exactly those leftovers so you can clean them up before publishing.

Tabs are not syncing

Check that:

  • the tab labels match exactly
  • the page does not set [tabs] sync = false
  • you are using Hextra’s tabs and tab shortcodes, not a copied custom variant

The sidebar or browser title still says Example Lesson

Changing content/_index.md only updates the homepage content. In a repository created from hugo-styles-template, also update these values in hugo.toml:

  • site-level title
  • params.lesson.title
  • params.lesson.repo
  • params.lesson.docsRepo
  • the GitHub URL in [[menus.main]]

The sidebar and browser title can come from Hugo metadata rather than visible Markdown text, so grep may not find the old title in content/.

A glossary or profile link is broken

The shortcode target should match the content slug, for example:

  • content/glossary/formative-assessment.md -> {{< glossary formative-assessment >}}
  • content/profiles/workshop-host.md -> {{< profile workshop-host >}}

TOML front matter reports an invalid escaped character for LaTeX

TOML double-quoted strings treat backslashes as escapes, so \( ... \) fails unless every backslash is doubled.

Prefer literal strings in front matter:

objectives = [
  'Clone and configure the \(t\bar{t}\gamma\) analysis repository.'
]

If the same expression renders in the Markdown body but not in questions, objectives, or keypoints, check your lesson’s hugo.toml. When you override [markup.goldmark.extensions], keep the passthrough block from hugo-styles so \(...\) and \[...\] still reach the math renderer.

Search updates but results seem odd

Aggregated pages such as All-in-One, Key Points, and External Links are intentionally excluded from indexing so they do not crowd out the main lesson pages. If a result feels missing, check whether the relevant page is a generated resource or a real content page.

A downstream lesson does not pick up a shared-module fix

First confirm that the fix has been included in a hugo-styles release. Then run the lesson repository’s Refresh vendored Hugo modules workflow and merge the pull request it opens. If the change still does not appear after rebuilding, look for a local override in layouts/, assets/, or archetypes/.