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.

Changelog #

Entries summarize user-facing changes from the commit history. Small fixes and related changes are grouped together.

2026.05 (upcoming) #

  • Breaking Reworked the schedule shortcodes with more flexible week, event, lecture, and resource rendering. (f9131b2, c9069b2)
  • Feature Added Bootstrap-native row and column shortcodes, buttons, badges, Markdown includes, and additional badge colors. (57a1cf1, 32fdabb, 72df9d8)
  • Feature Added a syllabus-style header shortcut and new image treatments for covers and outlined figures. (59bb78f, abb767f, bb0dc1b)
  • Improvement Moved JavaScript and SCSS handling into Hugo Pipes and added static fallbacks for more reliable deployment. (59a2ab4, 4b95b54, fcae0c7)
  • Improvement Extended the documentation and accessibility support, including clearer metadata and a smaller default logo. (18d5677, 8b1fca9)
  • Fix Fixed mobile definition-list and footer wrapping, card borders, secondary links on red backgrounds, and footer configuration. (11f68fc, 5e0ec3a, 577d992, 248a4b9, 836325b)
  • Maintenance Updated templates and example configuration for current Hugo APIs. (a21c7cc)

2024.08 #

  • Breaking Migrated the theme layout and styling to Bootstrap 5. (5cc4723)
  • Feature Added schedule, assignment, and details shortcodes with data-driven lecture resources and deadlines. (e5ce32a, 3c19f69, 8eb4651)
  • Feature Added the example site, theme configuration, default logo, and configurable footer and work-in-progress notice. (7e74621, 9453ebc, f64cf84)
  • Improvement Added configurable column splits and improved chart sizing and identifier handling. (9b0679e, e2ff5e3)
  • Fix Corrected responsive breakpoints, narrow layouts, duplicate notices, and assignment date formatting. (4256cf9, 8740b43, 0e7ec7a, 93693cb)

Bootstrap 3 #

  • Feature Established the original course-site structure with navigation, sidebars, tables of contents, alerts, charts, and course metadata. (b5bbf0c, 5cf63ba, 029fd22)
  • Improvement Added semantic HTML, print styling, skip links, header anchors, and last-modified support. (58a0ae7, b0395d6, 9577aca)
  • Fix Improved menu rendering on small mobile screens. (e18fa31)