Academic Template for Hugo

This template serves as a quick and easy way for job market candidates to set up their website. It is a stripped down version of the Hugo Academic template. For full features of this template, see its documentation.

The colours come from McGill's visual identity guide.

Here's the demo.

Getting Started

Initial setup

• On GitHub, fork this repo
• On Netlify
  • Sign up with your GitHub account
  • Create a new site, using the repo you just forked. Your website is now live!
  • Get your own domain, either from Netlify or from another provider. See details here

Editing your site

• Clone your repo to work on it locally

git clone [email protected]:$YourGitHubUsername/McHugo.git
cd ./McHugo

• Change the website info in ./config/_default/config.yaml

• Update relevant info (SEO, initials) in ./config/params.yaml

• Change the contents in ./content/

• Add linked files to ./static/files/

• Add your profile picture to ./content/authors/default/avatar.jpg

• Copy this image to ./assets/media/sharing.jpg for it to show up in search engines

• Pushing updates to GitHub will automatically trigger Netlify to rebuild your website

git add .
git commit -am 'Updated content XYZ'

To preview your site locally, you will need to install Hugo Extended and Go

• See instructions for installing Go and Hugo. On MacOS with homebrew:

brew update
brew install go hugo

• To preview your site locally, run

hugo server

• To get more advanced features (e.g.: view draft website on netlify, debug serverless Lambda functions), check out the Netlify CLI

Google Sheets Site and CV Builder

Thanks to Derek Chan, you can generate build contents of your site and CV from a Google Sheet. These files are in the ./build/ folder.

The R scripts read information from a Google Sheet and builds the PDF CV, publications pages, experience module on Hugo.

The CV building code is adapted from Nick Strayer. Some features have been taken out in this version for simplicity and compatibility.

Initialization

• Copy this googlesheet.
• Modify the main_sheet, contact_info and text_blocks. The rest of the sheets should not be modified.

To update

To update the CV and site entries

• Open ./build/run.r
• Modify the data_location to your own Google Sheet.
• Run the script.
• The CV PDF will be placed into the ./static/files/ folder by default. The ./content/publications/ folder and ./content/home/experience.md file will be updated.

Note: this will overwrite existing files

• The site is ready to be built.

Customization

• To change the cv appearance, modify cv.css.