Link Search Menu Expand Document
CRDDS Research Data Bootcamp

Time to press some buttons!

Overview

During this hands-on portion, you will fork a repository over to your own GitHub account, activate it as a website tied to your GitHub username, and work on adding new content and customizations.

Fork the sample template repository

Step 1

Go to https://github.com/CU-Boulder-CRDDS/pages-sample

Step 2

Click the Fork button to make a copy of this repository on your own GitHub account: Fork it

Head over to your account to view your fork of this repo.

Edit your _config.yml file

Step 1

Click on the _config.yml file to open it.
Open Config

Step 2

Click the edit button. Edit

Step 3

Change the url field to match your username. On line 28, change:
https://CU-Boulder-CRDDS.github.io to https://your-user-name.github.io Change url

Step 4

Scroll down, add a commit message, and click Commit to save the changes: Commit

“Spin up” your site!

Step 1

Go to your repository Settings: Settings

Step 2

Click the Pages tab at bottom left: Pages

Step 3

Under source, switch the branch to main and click save: branch

Your site is building! This can take up to a few minutes. Head over to: [your-user-name].github.io/pages-sample in a new browser tab to see the result.

Playtime! Now let’s work through some basic customizations

First, open up your _config.yml file and modify the contact info, title, and description:
Mods

Let’s make some changes to the homepage:

Now let’s make some changes to the content of the home page.

Step 1

Open index.md and click Edit.

Step 2

Take a minute to modify the content of the homepage. Add some dummy text and perhaps a link. Links look like this:

[dummy text](http://fillerama.io/)

Now let’s talk about Layouts:

You’ve figured out by now that your content pages are saved as Markdown (.md) files.

Information like the layout type, title, and navigation (if applicable) are set in the front matter of the page’s markdown file.

It looks like this:

---
layout: default
title: Home
---

The layouts available will depend on which theme you are using. For this example, we are using the default Jekyll theme, called Minima.

When GitHub builds your site, it references the theme indicated in the _config.yml file, which indicates which theme you are using (we will discuss themes more in a minute).

Take a look now at the repo that contains the Minima theme. Open the _layouts folder and you can see you have a few different layouts to choose from.

Change the layout of your index.md file to home

Tread lightly here… not all themes support different layouts. Many only have one page layout: default

Open your index page in the editor and change the front matter to this:

---
layout: home
title: Home
---

Enter a commit message and click Commit. Let your site reload and few the results…

It’s changed! What is all this “Posts” stuff?

Let’s talk about Posts!

Jekyll is a popular platform for blogging, and the “post” layout is fairly common across different Jekyll themes.

In your repository, open the _posts folder and you can see that I’ve provided several example posts.

Posts must be saved in the _posts folder, and they must always be formatted as yyyy-mm-dd-title-of-post.md. This is how they show up properly in the feed.

You must also set the layout as ‘post’ and provide the a category in the front matter, the value of which can be whatever you want. Date is also good:

---
layout: post
title: Something smart and academic
date: 2021-08-03
categories: science
---

Adjusting Themes

GitHub Pages supports several Standard Themes

Try changing the theme of your site to one of these standard themes.

Open your _config.yml file, got to line 33 and change: theme: minima to theme: jekyll-theme-architect

Commit the change and see what happens upon build…

What went wrong?

When switching themes, pay particular attention to the layouts! You may need to check the theme repo to see if it uses the same layouts your pages or posts use (see _layouts folder). If not, you may need to change layouts of your markdown files.

Fix it Change the layout of your index.md file to default.

2 Remote Themes

In addition to the standard themes, you can also use “Remote Themes”, of which there are hundreds.
GitHub Pages Remote Themes

If you’re relying on remote themes, your mileage may vary here! Be prepared to troubleshoot.

Truth: If you want to use themes beyond the standard GH Pages themes, it is best to clone a theme’s repository, work on it locally, and push it to a new remote repository on your GitHub account. This will give you further control over the look and feel of your site and a lot of flexibility…

See Advanced