Repository Structure

Structure

The build folder contains scripts that will convert markdown files into a variety of formats.
- md_to_html.sh: Converts a markdown file into a variety of other formats, including HTML. Run the script without arguments for usage information.
- build_all.sh: Converts all markdown files in the src folder into HTML files with the same directory structure in the out folder.
The doc folder contains some documentation for contributors, separate from the wiki. This could include sample files and other examples that would be best shown in the form of a file.
The src folder contains all the materials created, and each folder src/* contains the resources for that specific topic. A table of contents is created in index.md to show all of these folders, sorted (roughly) by the order in which they are taught in Introduction to C (COP 3223).
The static folder contains additional assets that can be used broadly for all materials, like images. Images specific to a topic should be located in the same or close directory as that topic.
The templates folder contains the template files used for exporting with pandoc.

File names are written in kebab-case. Spaces should not be used in file names.