hugo-theme-ncsu #

Unofficial NC State-inspired Hugo theme for course websites. It provides a Bootstrap 5 layout, course navigation, schedule components, assignment helpers, and accessible course metadata patterns.

NC State themed site logo

Start Here #

Use the theme when a course site needs a clear syllabus, schedule, assignment pages, and reusable Markdown shortcodes. The example site includes working pages for schedule data, shortcode output, and Markdown rendering.

Course Example Config Shortcodes

Included #

Layout
Header, sidebar, table of contents, footer, and work-in-progress notice
Course Data
Site parameters for course title, description, meeting time, and location
Shortcodes
Alerts, badges, buttons, cards, tables, definition lists, charts, assignments, and schedules
Examples
Theme documentation, schedule sample, and Markdown compatibility page

Getting Started #

Create a Hugo site, add this theme under themes/, and copy the example config into the new site.

1
2
3
4
5

hugo new site course-site
cd course-site/themes
git submodule add https://github.com/wspr-ncsu/hugo-theme-ncsu.git
cd ..
cp themes/hugo-theme-ncsu/hugo.toml .

Run the site locally while editing content.

1

hugo server

The theme requires Hugo extended because it uses SCSS. Use the example site as a working reference for content pages, data files, shortcodes, and theme configuration.

Documentation #

  • Config: Site settings, theme parameters, partial overrides, and data file schemas.
  • Shortcodes: Bootstrap wrappers, assignment helpers, chart output, and schedule components.
  • Course Example: Student-facing course page with selected schedule examples.
  • Markdown: Markdown rendering compatibility page.