## Content Formatting Documentation All modules are written in [Markdown](https://www.markdownguide.org/cheat-sheet/). There are special additions to the markdown that we have added to this site. These special additions are still under development, so they may change frequently. If you are confused about something, or if there's a certain feature that you want to add, reach out to Nathan Wang. You can use [StackEdit](https://stackedit.io/) to check that latex renders properly. ### `ordering.js` Located at `content/ordering.js`, this file stores the ordering of the modules. Hopefully the format is self-explanatory (it matches based on "slug"). Let Nathan Wang know if you have questions. ### Frontmatter [Frontmatter](https://jekyllrb.com/docs/front-matter/) is the stuff in the beginning of each module that's surrounded by three dashes. Frontmatter is written in [YAML](https://yaml.org/). It stores the "metadata" for each module. YAML formatting is _extremely strict_. Be careful about spaces. - **ID**: _Required_. The ID of the module. Ex: `getting-started`, or `containers`. This ID is used to identify the module, so make sure it is **unique** and **all lowercase with dashes only**. The URL will be generated based off this. - **Title**: _Required_. The title of the module. Ex: `Getting Started` - **Author**: _Required_. The author of the module. Ex: `Unknown` - **Prerequisites**: _Optional_. Any prerequisites for this module. The prerequisite formatting is rather unintuitive. It expects an array of arrays, where the first item is the name of the prerequisite, and the optional second item is a link. **Note the number of spaces!** Example: ``` prerequisites: - - Prerequisite Name - https://dummy.prerequisite.link.com/ - - Another Prerequisite Without a Link ``` - **Problems**: _Optional_. A list of problems in the article. As we haven't figured out what we're going to do with **it's best to not include this yet.** For USACO problems, enter each problem as `division_filename`. Ex: `bronze_promote`. ### Module Description Everything after the frontmatter, and before this line: ``` ``` is part of the "module description." It gets rendered on the homepage. Be careful not to use headers as they will look really weird on the homepage. The module description is also included in the article itself. If you don't want a description for the module, just put the `END DESCRIPTION` line as the first line after the frontmatter. If you want a description that appears only on the homepage but not the article, wrap it in an HTML element with the class `syllabus-only`. Note that you can't use markdown in HTML elements. Example: ```