Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (29 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

34 lines (29 loc) · 1.53 KB

Contributing

Modules

  1. Pick a section in the outline documentation and make sure you are familiar and confortable with the content.
  2. Create a new module directory in the modules folder. If you have module 2, then create modules/module_02.
  3. Make a copy of the outline template and rename it to module_N_outline.md where N is your module number. Save this in your module directory.
  4. Repeat the previous step with the slides template and homework template.
  5. Using Marp, export your slides and homeword as a PDFs and save them to the module folder. (File > Export Slides as PDF)
  6. I'm using ghmd (npm i -g ghmd) to generate an html file of the homework, opening it in Chrome, and using the save to PDF option when printing the file. I then save it to the module folder.
  7. Same goes for the outline file.
  8. Upload to Canvas (WIP)

Slides

Slides are generated using Marp which uses markdown for its formatting. This will give us a consistant look and feel to every slide deck, even when different people are working on different sections. For an introduction to markdown, follow this link. And for examples of how Marp translates markdown formatting into slides, follow this link for an example slide deck.