Skip to content

Latest commit

 

History

History
108 lines (82 loc) · 3.05 KB

README.md

File metadata and controls

108 lines (82 loc) · 3.05 KB

WMRRA.com

Welcome to the repository for the WMRRA.com website!

Running Locally

This project uses a static site generator called Hugo.

  1. Install Hugo.

    $ git clone https://github.com/gohugoio/hugo.git
    $ cd hugo
    $ go install --tags extended
  2. From the root of this repository run hugo server from a commandline.

  3. browse to http://localhost:1313

Contributing

If you would like to suggest a feature or report a bug, you can file an issue.

We welcome contributions from the community. A good place to start is to create an issue and to discuss the change you would like to make before proceeding.

Common Tasks

Here are a few common updates you may want to make to the site.

Adding a news post

News posts are nested under content/news

It is likely easiest to copy the last post and use it as a template for your newest post.

Each post needs to include the following fore-data:

---
title   : "A title of a post"
date    : "2021-01-01"
draft   : false
description: "A brief description of the post that shows on the front page."

Updating Schedules

The schedule is defined at data/schedule.yml

Updating Racer Numbers

While the page has been de-linked as it isn't up to date, /race/racers serves a tile grid of racer numbers and photos of their bikes.

The racer numbers are defined at assets/csv/race-numbers.csv The racer photos are defined at static/images/racers/

Images must be named the race number and must of type png. They are 346x300px in dimensions.

Updating the Menu

The menu is defined at data/menu.yml

Menu items can either be a top-level link or label with links in a submenu.

Top-level links are defined this way:

- name: Volunteer
  link: /volunteer

Labels with submenus are defined this way:

  - name: Resources
    children: 
      - name: Schedule
        link: /race/schedule
      - name: Rulebook
        link: /race/rulebook

Updating Sponsors

Sponsors are listed in a data file at data/sponsors.yml

A sponsor entry is defined as follows:

  - name          : Sponsor Name
    image         : images/sponsors/sponsor-placeholder.jpg
    description   : >
      Lorem ipsum dolor sit amet consectetur adipisicing elit. Aspernatur
      necessitatibus ullam, culpa odio.
    social:
      facebook : https://www.facebook.com/
      twitter  : https://twitter.com/
      website  : https://website.com/

Updating Contacts

Contacts are listed in a data file at data/contacts.yml

A contact is defined as follows:

  - position: Position Name
    name: First Last
    phone:
    email:

Other Pages

Pages on this site can be found at content or layouts/partials