Giter Club home page Giter Club logo

mchugo's Introduction

Academic Template for Hugo

I created this template 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

mchugo's People

Contributors

evanjo avatar qzhou-2020 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.