Quick Start Guide

Before you get started

Check out our example site at https://idahatiu.github.io, which has example items of several different types–photos, document scans, videos–so you don’t have to start from scratch.

The 5 steps below will guide you through making a copy of our example site and customizing it for your community.

Step 1

Create a new Github.com account by following this video: https://youtu.be/plg5QomrHHg

  1. Your Github username should be the name people will search for to find your community. For instance, a community group called “New City Community Archive” would choose the username “newcitycommunityarchive”
  2. The “free” option will mean people can see, but not edit, the files that run your web site.

Step 2

Make a copy of our template community-archive site by following this video: https://youtu.be/aDQZ1lcpMn0

  1. Visit https://github.com/idahatiu/idahatiu.github.io
  2. Press the “Fork” button
  3. Rename your repository yourusername.github.io (where yourusername is the username you chose when you created your Github account)

Step 3

Customize the _config.yml with your community information by following this video: https://youtu.be/UR3RSXWGpJo

The _config.yml file contains settings for exhibit info, font, and color choices that affect the entire web site.

  1. Select the _config.yml from the list of files in your repository.
  2. Click the pencil button to edit the file
    • Information about your community is on lines 42-63. To leave a line blank, put two quote marks together with no spaces, like so: twitter: ""
    • Choices for colors and fonts are on lines 77-93.
  3. Scroll to the bottom and use the “commit” button (Github’s version of a “save” button)

Step 4

Add your first item by following this video: https://youtu.be/LoFCewSXC7c

Each item in the collection has an item ID (no spaces or punctuation) with one or more files associated with it (e.g. 0001.md).

  1. Open the _items folder and look at one of the example items. Get a feel for what you need to gather about each item.
  2. Each item should have its own unique filename.
    • We like YYYY-MM-DD-ItemNo (so the 4th item collected on May 15, 2022, would be 2022-05-15-004)
  3. Each item will have its own information file in the _items folder (2022-05-15-004.md) and a photo in the /assets/items/ folder (2022-05-15-004.jpg or 2022-05-15-004.png).
    • The file for each item in the _items folder has a bunch of information about each item in the first few lines. Each line has a field type (e.g. author), and then a colon, and then the info that goes in that field surrounded by double quotes (author: "Drew H"). You can get more information about what goes in these item fields in the Metadata: Line by Line section of the Theme Docs.

Step 5

Publish your site using Github Pages by following this video: https://youtu.be/MC7_-Cx-i_E

  1. Find the “Settings” link on the top-right bar of your repository’s info page
  2. Find the “Pages” link on the left-hand side of your repository’s settings page
  3. Look for a text box with a green or blue background at the top that says “Your site is published” or “Your site is ready to be published”
    • If you see a green box, you’re ready to go. Click on the link!
    • If you see a blue box, wait 5 minutes and reload the page. It should be green now, and you can click on the link.
    • If you don’t see either message, look for the drop-down menu that says “Branch”, choose the “main” branch and press “Save” to publish your site in Github Pages.