Welcome! This is the new website for the Berkeley Math Tournament, a UC Berkeley student-led organization that aims to spread mathematics and the spirit of mathematical competition globally.
This site is still in early development. One of the primary goals is to make it easy for anyone to add and update content. To that end, the site is built with Zola, a static-site-generator that renders content from Markdown files.
If you're familiar with Git and GitHub, it should already be fairly easy to edit content following the instructions listed in this readme. However, we're also working on adding a visual, git-less way to do basic edits (basically anything that doesn't involve a custom element or layout). Stay tuned for that!
Most content is rendered from Markdown files that live in the content/
directory.
To add or edit a page, simply work on a file in the appropriate location:
| Path | Page | Notes |
|---|---|---|
content/_index.md |
The Home tab | Fancy banner is in the index.html template |
content/about.md |
The About tab | |
content/sponsors/index.md |
The Sponsors tab | In a folder to colocate sponsor logos |
content/news/*.md |
News posts | File names should be prefixed with the date |
content/events/*.md |
Event detail pages |
These content files are written in Markdown, which is a lightweight way to add formatting to plain text documents. If you've sent bold text on Discord (or many other platforms), you've already used Markdown!
For those unfamiliar, a cheat sheet is available here.
In addition to standard Markdown, we provide the following special components, called shortcodes:
| Shortcode | Example | Rendered |
|---|---|---|
| Button |
{% button_link(href="https://contestdojo.com/") %}
Register on ContestDojo
{% end %}
|
|
Every Markdown file in this repository also has a special block at the very top
called front matter, delimited by +++. Here, you can specify additional
properties for each page, such as the title or date.
If you're adding a new page and not sure what to put for front matter, try looking at a page similar to the one you're adding and basing it on that. Feel free to ask the Tech team any questions.
Changing how content is rendered or adding special elements (like the banner on the home page) may require editing a template. Templates are written in Tera, a template engine for HTML.
The default template is page.html for pages and section.html for section
listings (like the News tab which lists all the posts). The home page has its
own index.html template.
Most pages are based on the base.html template. Common changes, such as adding
a tab to the tab bar, probably belong here.
It is recommended to test the site using the Nix package manager:
nix run .#serveIf you don't have Flakes configured globally, you may need to pass in
--extra-experimental-features "nix-command flakes".
A development server should now be running at http://localhost:1111. It should update automatically as you edit the site, so this is suitable for development.
To test the site without Nix, ensure that you have Zola and Tailwind CSS installed. Then, simply run the following commands to get the site running:
tailwindcss -i ./static/input.css -o ./static/style.css --watch &
zola serveIt is recommended to build the site using the Nix package manager:
nix buildThis will make a static build of the site and place the files in the public/
folder. Simply copy these files to a web host using your tool of choice to
deploy.
To make a production build for use at https://berkeley.mt/, run:
nix build .#for-productionThis sets the base_url option correctly, so that SEO is optimized.
Commits to the main branch on the main repository will automatically be
deployed to the live site. Look out for little green check marks next to commits
on GitHub!