Hello! This is the UCC STEM website, which is built using Jekyll and deployed through Github Pages. This documentation provides info for the parsed pages, instructions on how to access website files, and how to create pages (for devs).
If you are not a developer and want to add a page, please submit your page information through this google form.
Most pages on this website are parsed using Jekyll and exist as a Markdown file (.md extension). If you are unfamiliar with markdown, it is essentially a text file with additional symbols that are used to denote styles (bold, italics, etc). You can learn more about markdown stylings using this reference.
The event pages, as markdown files, are stored in the _events folder located in the root directory.
For our webpage, each markdown file (webpage) begins with metadata which provides info about the event. The file structure of markdown (example):
---
name: "Sample Event"
date: "2021-02-15"
tags: "Biology"
image: "example_photo.png"
intro: "One sentence intro of the event."
status: "ongoing"
---
The actual content of the event goes here.
This is the webpage for the event. It supports
complete Markdown formatting, so you can insert links in
paragraphs [like this one](http://example.com) or format
text **to be bold**, *italicized*, or make lists:
1. Number one
2. Number two
* Unordered one
* Unordered two
| Field Key | Value | Required? |
|---|---|---|
name |
What the event is called! | ✅ |
date |
The date of the event, in the formatYYYY-DD-MM |
✅ |
image |
The filename of the banner image, located in our /assets/events/ folder. For example bio_comp.img |
✅ |
intro |
A brief one-sentence description of the event. | ✅ |
tags |
The category and related fields of this event | ❌ |
status |
Current status of event. Allowed fields are ongoing, upcoming, and completed |
❌ |