SSL Hugo Website

The SSL website, now powered by Hugo!

Table of Contents

• SSL Hugo Website
  • Table of Contents
  • About
  • Development Requirements
  • Deployment
  • Maintenance
    • How to Update the Home Page
    • How to Add People
    • How to Add Publications

About

This repository contains the Software and Systems Laboratory (SSL) website source code.

This website is powered by the hugo static site generator and the Wowchemy Research Group theme.

Development Requirements

To develop this site, you will need to have installed:

• hugo
• golang
• Python 3.10
• academic Python utility

To install these with homebrew, run:

brew install hugo golang python@3.10
brew link python@3.10
python3.10 -m pip install --upgrade pip
python3.10 -m pip install academic

Deployment

This site is deployed once per commit via GitHub Actions.

Maintenance

How to be a good maintainer

How to Update the Home Page

1. Work within the ./content/home
2. Create new markdown (.md) files for each section of the document OR edit an existing section's .md file.

How to Add People

1. Work within the ./content/people
2. Copy an existing person's directory and change the name to the name of the new individual to add
3. Edit the new person's _index.md file and add the appropriate details
4. Replace the new person's avatar.jpg file with a headshot of the individual.

How to Add Publications

1. Run the following command block

python3.10 -m venv env
source env/bin/activate
python3.10 -m pip install --upgrade pip
python3.10 -m pip install -r requirements.txt

1. Then run the following command, replacing `$BIB with the path to your bib file

./addPublications.bash $BIB