The official repo for the ryersonbikes.com website. Written in Markdown and JavaScript, the ryersonbikes repo provides the infrastructure for the creation of the website onto the web.
-
Make sure you have the enhanced version of hugo, from https://gohugo.io/getting-started/installing/
-
Add the repository to your local computer using git.
- To make edits, add a new page (example from the root folder, to make a new activity):
hugo new activities/volunteering.md
- Make sure to remove the 'draft' indicator, add all your new edits, and add the change.
git add activities/volunteering.md
- Commit it to your local staging area:
git commit -m "meaningful commit message here"
- Push it back to the github repo!
git push origin master
- Watch the Netflify status bar on the top, to make sure that your changes were published!
All the images to be used are located in the static -> img folder. To add files here, simply drag and drop from your explorer to the folder. Please limit the size of the images to at most 500 Kb to keep the site running light.
There's quite a few entry points to editing the overall structure of the site. This section aims to show how to access these points and what to do with them in an FAQ-like format.
All entries assume a starting point at the root of the project.
- Navigate to the config.toml file in the root directory of the project.
- Then, within the file, navigate to these sub-sections:
config.toml > [menu] > [menu.main] - Add a line for the name that will be shown in the navigation bar, the url suffix and the weight: the order in which this heading, relative to others, will be shown.
As an example, let's create an article for the bike-repair section. For the following instructions, you may need to change the orientation of your slashes. These instructions assume Windows as an operating system and Powershell as a command line interface.
-
Run the hugo new post command from the root directory. If you don't know what your root directory is, on a command line, navigate to
$Your-user-directory\ryersonbikes.com. The hugo command to run afterwards is:hugo new .\content\resources\bike-repair\my-first-post.mdReplace my-first-post with the title of your desired article.
-
Open this file up in your desired text editor. You'll see the following:
---
title: "My First Post"
date: 2020-06-15T12:26:30-04:00
draft: true
---
The title will be all the dash separated words capitalized, and the date and time of when you ran the command will be saved. Additionally, the draft flag will be set to true. This means that, until you remove the line with this attribute, your post will not be shown.
That's it! If you need a refresher for mark down, I highly recommend starting with this resource.