This repository contains the source files to generate the MathsJam website.
- You need a GitHub account to edit the site. If you don't have one, sign up first - it's free!
- Find the file you want to edit, and click the
Edit this file
button (it's a little pencil icon). The files for individual Jams are in thecities
folder. Alternatively, each page on the site has an "edit this page" link at the bottom; clicking this will take you to the corresponding GitHub page. - Make your changes, then describe what you've done in the text field at the bottom and click "Propose file change".
- This will allow you to create a pull request, which one of the admins has to approve. They might request further changes or make their own edits. When the pull request is approved, the change will be published to the site.
Information about each city is stored in a file in the cities
folder.
Other pages are generated from .md
files in the repository. The front page is generated from index.md
.
Create a file cities/cityname.md
, following this template:
---
layout: city
city_name: CityName
jam_name: CityName MathsJam
email: [email protected]
twitter: CityNameMathsJam
organiser:
name: Organiser's name
email: [email protected]
location:
group: england/rest-of-uk/north-america/rest-of-world
pub_name: "Ye Pub"
description: " on X Street"
url: http://www.yepub.website
lon: 1.00000000 (get the lat and long from google maps)
lat: 50.0000000
hiatus: False (change to True if the Jam is not currently running)
jam_date_rule: second-last tuesday
start_time: 7pm in the evening
---
All the data from this file will be used to create the page for the Jam, and all other references to the city throughout the site.
If your Jam doesn't meet on the second-last Tuesday of the month, you can add a line for 'jam_date_rule' and follow the convention of 'first/second/third/fourth(-last) Weekday', e.g. fourth Thursday, third-last Saturday. If you can't work out how to word it, do your best and we can fix it before merging.
If you need to put your MathsJam on hiatus for a single month, this is also possible.
- Christian Lawson-Perfect (@christianp)
- Katie Steckles (@katiesteckles)