How do I update this website?

Published:

This post serves as internal documentation for this website, detailing the key steps required to build, maintain, and deploy it. It might also be useful to others as a reference for setting up a modern academic website using Jekyll and my fork of the AcademicPages theme.

Setup on Mac OS for local development

brew install chruby ruby-install node
add to .zprofile
  source /opt/homebrew/opt/chruby/share/chruby/chruby.sh
  source /opt/homebrew/opt/chruby/share/chruby/auto.sh
  chruby ruby-3.4.1
source .zprofile
check version with ruby -v and gem -v
gem install jekyll bundler
clone academicpages repository to some folder
cd to the newly cloned repository
bundle install
bundle exec jekyll serve -l -H localhost

Deployment to VPS

bundle exec jekyll build
rsync -rz -e 'ssh -p ...' --progress --delete _site/ bruno@...:/srv/www/brunodegliesposti.com/
test live website
commit changes to git repository

Changing the front page

Simply edit _pages/about.md

Changing the publications page

The page can be changed by editing _pages/publications.md. To add a publication, create a new file in the folder _publications according to the following template:

---
title: "..."
collection: publications
category: books/manuscripts/conferences/wip/extendedabstracts/dissertation
status (only for wip): in preparation/submitted/under review/accepted
permalink: /publication/...
excerpt: 'Joint work with [someone](url). Truncated abstract...'
date: yyyy-mm-dd
venue (only for manuscripts and dissertation): 'Name of journal'
paperurl/preprinturl/slidesurl/thesisurl/bibtexurl: '...'
---

**Abstract:** ...

Paper available in open access from the [publisher's website](url)

Changing the talks page

The page can be changed by editing _pages/talks.md. To add a talk, create a new file in the folder _talks according to the following template:

---
title: "..."
collection: talks
type: "Invited contribution to the minisymposium \"...\""
  or "Contributed talk" or "Contributed poster presentation"
permalink: /talks/...
venue: "University of ..."
date: ...
location: "City, Country"
---
Full name of the event [abbreviation](url).

Changing the projects page

The section "Affiliations and Research Funding" can be changed by editing the file _pages/portfolio.md. Each file in the folder _portfolio corresponds to an entry in the section "Prospective Research".

Changing the teaching page

The page can be changed by editing the file _pages/teaching.md. Each file in the folder _teaching corresponds to an entry in the list at the bottom of the page.

Template customization

I have removed the theme toggle button by editing _includes/masthead.html.

I have edited _includes/archive-single.html and _layouts/single.html to support category==’wip’ (work in progress publications) and category==’dissertation’. Otherwise the pages of those works would incorrectly report a publication date.

Linking to a file

Just drop it in the files folder, and use relative URLs

[description](/files/example.pdf)

Useful documentation