diff --git a/README.md b/README.md index 4ab6fc5..649827d 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,47 @@ To add or edit a page, simply work on a file in the appropriate location: | `content/news/*.md` | News posts | File names should be prefixed with the date | | `content/events/*.md` | Event detail pages | | +## Writing Markdown + +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](https://commonmark.org/help/). + +In addition to standard Markdown, we provide the following special components, +called _shortcodes_: + + + + + + + + + + + + +
ShortcodeExampleRendered
Button +
+{% button_link(href="https://example.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. + ## Editing templates Changing how content is rendered or adding special elements (like the banner on diff --git a/button-example.png b/button-example.png new file mode 100644 index 0000000..76fa727 Binary files /dev/null and b/button-example.png differ