Skip to content

Commit

Permalink
change readme wording
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-ni committed Oct 3, 2023
1 parent 7dd4c75 commit b104293
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Welcome! This is the new website for the
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 of the site is
to make it easy for anyone to add and update content. To that end, the site is
built with [Zola](https://getzola.org/), a static-site-generator that renders
content from Markdown files.
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](https://getzola.org/), 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
Expand All @@ -20,13 +20,13 @@ 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 a page, simply create a file in the appropriate location:

| Path | Page | Notes |
| --------------------------- | ------------------ | ------------------------------------------- |
| `content/_index.md` | The Home tab | Fancy banner is in the 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 | |
| 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 | |

## Editing templates

Expand Down Expand Up @@ -68,4 +68,5 @@ folder. Simply copy these files to a web host using your tool of choice to
deploy.

Commits to the `main` branch on the main repository will automatically be
deployed to the live site.
deployed to the live site. Look out for little green check marks next to commits
on GitHub!

0 comments on commit b104293

Please sign in to comment.