OSU Overclocking Club Website

This is the website for the osu overclocking club.

Installation

Prerequisites

Read the HUGO quick start guide

You can check that Hugo is installed in the terminal by running:

hugo version

Setup

Once the Hugo is installed, clone the repository to your local machine.

From the command line:

git clone git@github.com:osu-overclocking/osuoverclocking.com.git ./osuoverclocking.com

Finally, install the submodules to load themes.

git submodule update --init --recursive

Local Development

You can run the server locally with drafts or not.

# No drafts
hugo server

# Drafts
hugo server -D

When Hugo is done building, you should see a success message like:

Web Server is available at //localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Contributing

Pull requests are welcome; although this site mostly for club leadership to write posts and give information vital to the club. Check out our wiki! as it is more accessible to outside contributions.

For more information about how this theme works, see the ananke repository.

Posts

All posts are written in markdown! You can use that to make fancy headings and other markings on the page.

To create a post, run

hugo new content post/{Post_Name}.md

which will create the template file.

Note: You should use snake case for file names eg everything lowercase and underscores instead of spaces.

It should look similar to:

+++
title = 'Post_Name'
date = 2024-02-23T00:05:31Z
draft = true
+++

You can change the title there to make it more human readable. The draft section controls whether the post is published or not; make sure to change that to true when it is ready to be made public.

After that header, you can write markdown and it should be interpreted on the site.

Submitting PRs

When you are ready for your changes to go live, submit a pr to the main repository with your branch and it will be reviewed and be added to the repository.

Partners

IEEE OSU MICRON INTEL