Creating an academic website on GitHub

1 minute read

Published:

Learn how to create a website to showcase your academic achievements! This tutorial will walk you through setting up an academic website on GitHub. You can add publications, blog posts, and a CV to your website to share with people as you network! We will get some more practice with the terminal by interacting with the Git command line interface (CLI).

Preparation (reviewed in previous workshop)

  1. Fork the Academic Pages repo.

  2. Rename the repo to your GitHub username:

  3. Click on the green “Code” button and copy the link to clone your own repo.

  4. On your terminal, run:

     git clone <insert link here>
    

About page

  1. Open your integrated development environment (IDE) and open up the directory containing your cloned repo.

  2. Open the _pages directory and click on the about.md file.

  3. Remove all the text under line 9 (highligthed in blue).

  4. Edit the header information (title, excerpt)

  5. You can add an image by placing it in the images directory. Use the following code to include it in your page:

     <img title="<fill in with caption title>" alt="Alt text" src="images/<fill in with image name>">
    
  6. Add, commit, and push your changes:

     git add *
    
     git commit -m 'changes to about me'
    
     git push origin
    
  7. Now, navigate to your website, which is accessible at <GitHub username>.github.io


Publications page

  1. Open the _publications directory and click on the 2009-10-01-paper-title-number-1.md file.

  2. Edit the title, permalink, etc. Example below:

  3. Create a new file for each publication.

  4. Add, commit, and push your changes:

     git add *
    
     git commit -m 'changes to publications'
    
     git push origin
    
  5. Now, navigate to your website, which is accessible at <GitHub username>.github.io


CV page

  1. Open the Open the _pages directory and click on the cv.md file.

  2. Add your education, work experience, and skills. Example below:

  3. Add, commit, and push your changes:

     git add *
    
     git commit -m 'changes to cv'
    
     git push origin
    
  4. Now, navigate to your website, which is accessible at <GitHub username>.github.io