A Rapid Workflow for Publishing CS Teaching Materials

Summary

It is both a feature and a bug of Computer Studies courses that there are few, if any, published textbooks that match the Ontario curriculum. As a result, most teachers write their own materials and have developed a workflow that fits their needs to share lessons and instructions with their students. In this session, the presenter will share a workflow that maximizes time we can spend communicating ideas and minimizes friction and time spent actually publishing and disseminating those materials. Bring your laptop computer: this is a hands-on session where you will set up the complete publishing workflow and learn how to use Markdown-formatted text files to quickly publish code snippets, diagrams, animations, and searchable, deeply linked pages to the web. Break free from manually typesetting documents in HTML or a word processor.

Author

Russell Gordon
Teacher, Lakefield College School

Note

This material was initially shared on Thursday, August 17, 2023 at the Summer Conference for Computer Studies Teachers, organized by the Centre for Education in Mathematics and Computing.

Output examples

A lesson that the author, in the past, might have conveyed using a PDF file (exported from presentation software) or with a video.

An end-of-module task for students to complete to demonstrate learning goal mastery.

A course website (half of the author's ICS3U course from 2022-23).

Resources

Important

All illustrations were made using macOS, but this is an entirely cross-platform workflow that has also been tested on Windows.

Obsidian is a key piece of the workflow. Obsidian runs on Linux, but publishing from that operating system has not been tested by the author.

Todo

Please consider supporting Ole Eskild Steensen, the author of the Digital Garden plugin.