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_: + +
Shortcode | +Example | +Rendered | + + +Button | +
++{% button_link(href="https://example.com") %} +Register on ContestDojo +{% end %} ++ |
+ + + | + +
---|