Food Stories Revision Guide
This guide is useful ONLY AFTER you have followed the directions for setting up your repository.
Once you have your own copy of the Food Stories repository AND your own version of the website is running (the URL will look like https://USERNAME.github.io/food-stories/), you are ready to proceed.
Save time with bookmarks
Create bookmarks for two locations you will be visiting often:
- YOUR own Food Stories REPOSITORY: https://github.com/USERNAME/food-stories/
- Replace USERNAME with your GitHub username!
- YOUR own Food Stories WEBSITE: https://USERNAME.github.io/food-stories
Create a folder and blank page
Go to YOUR repository (the URL will look like https://github.com/USERNAME/food-stories/). You should see the list of files in the repository (starting with folders like _data,_includes, _layouts, etc).
- Click the
stories folder
- Click the
Add file button in the upper right, and Create New File
- Type in a folder name for your essay:
- all lower case and with dashes (my-food-story) AND
- CONTINUE typing
/index.md - DON’T FORGET THE / AT THE BEGINNING
Name your folder correctly
Lower case and upper case are not the same. Spaces are horrible. If you don’t name your folder correctly, you will be frustrated later.
- all lower case, NO CAPITALS ANYWHERE
- no spaces, no underscores, ONLY DASHES
- it should like
mesa-vista-hall or maxwell-museum or johnson-field
- Click the green
Commit changes... button. Yes, you’re saving an empty file.
Copy a sample page into your blank page
- Click on the
stories folder.
- Click on the
bbq folder
- Click on the
index.md file
- Near the upper right of the screen, click the copy icon (two overlapping rectangles) to copy all the text.
Paste the sample into your new blank page
- Click on the folder your created (all lower case and with dashes)
- Click on the index.md file
- Paste the text you just copied.
- Update your page metadata as best you can right now (you’ll add an image later)
- Click the green
Commit changes... button.
Test your page
- Chill for a minute because there is about a minute lag between when you save your file and the website getting updated.
- Test your page by going to https://USERNAME.github.io/food-stories (you bookmarked it, right?) and add
/stories/YOUR-NEW-FOLDER/ to the URL to see your new page. Obviously replace your-new-folder with what you typed in the previous step.
- You should also be able to go to https://USERNAME.github.io/food-stories/stories
Bookmark your page!
Once you can get to your page, bookmark it! It’s easy to forget what th URL is to preview your page.