Skip to content

Project structure

theProton edited this page Aug 24, 2024 · 4 revisions

This section describes the structure of the codebase.

The directory structure of the project (according to Hugo specifications) and its various components are explained briefly below:

Layouts and partials

layouts/ | Read more

This directory contains all .html files that provide layout to the website. It is organised into sub-directories according to Hugo's file system rules and contain one directory for every page of the website (except the 404 page and the landing page which are in their own individual pages).

Currently, the following sub-directories are present:

  • _default/
  • about/ Layout of the about page
  • blog/ Layout related to the blog list and blog detail page
  • careers/ Layout related to the careers list page
  • events/ Layout related to the event list page
  • privacy-policy/ Layout related to the privacy policy
  • projects/ Layout related to the project list and project detail page
  • team/ Layout related to the team page
  • shortcodes/ Shortcodes to be used in the content markdown files

Additionally, there is a partials/ directory that contains reusable chunks of html.

Markdown files and content

content/ | Read more

This directory is the single source (or aims to be) of truth for all data displayed on the website.

Currently, the following sub-directories are present:

  • blog/ Spells out blog entries
  • careers/ Content related to the open positions in the club
  • events/ Content related to all events of the club
  • privacy-policy/ Spells out the privacy policy
  • projects/ Content related to the projects of the club
  • team/ Content related to the team members

Styling files

assets/ | Read more

This directory serves all the CSS files associated with the website. The files present are careers.css, events.css, footer.css, header.css, home.css, index.css, and team.css.

Content formatting

archetypes/ | Read more

This directory hosts files that serve as templates when adding new files to any subdirectory in content/.

Currently, there are only three kinds of markdown data files used in the website. They correspond to the following template files:

  • careers.md Corresponds to any file added to the careers/ directory
  • events.md Corresponds to any file added to the events/ directory
  • default.md Corresponds to any other content file

Static files

static/

This directory contains all images and files served publicly by the website. Each item resolves to a path relative to /, i.e. a file with the path static/images/null_logo.svg can be found at nullneu.pages.dev/images/null_logo.svg.

Currently, the following sub-directories are present:

  • company-logos/ Contains company logos of speakers who have been invited to null events
  • icons/ Contains all icons used in the website
  • images/ Contains all images used in the website
  • team/ Contains images of all team members
Clone this wiki locally