The following materials were prepared by Dr. Vedran Miletić and Matea Turalija from Faculty of Informatics and Digital Technologies, University of Rijeka for the workshop offered at Build Your Career Garden: Learning, Teaching, and Training Event.
Written teaching materials can have many forms: lecture notes, presentations, and even web sites. The authoring tools for the materials are still mostly tied to the specific form, but in the last decade the Markdown format has emerged as the solution that allows producing many forms of materials from the same content. This workshop presents a user-friendly approach to using Markdown in the production of teaching materials with open-source tools.
Markdown, according to Wikipedia, is a lightweight markup language for creating formatted text using a plain-text editor. It is implemented in many applications, including Microsoft Teams, Discord, RStudio, Kanboard, and Discourse.
While any plain-text editor can be used to write Markdown, many students at Faculty of Informatics and Digital Technologies like to use powerful integrated development environments such as Visual Studio Code and PyCharm. Unlike these developer-oriented tools, Zettlr is slim, fast, versatile, and user-friendly Markdown-specific editor that integrates well with reference managers such as Zotero and JabRef.
In the following, we will be relying on Zettlr's official documentation.
Markdown in Zettlr
- Markdown basics, emphasis on Markdown 101: The most important codes and Zettlr Markdown additions
Editing and exporting documents
- What You See Is What You Mean (WYSIWYM)
- Exporting, emphasis on exporting to HTML, OpenDocument Text, Microsoft Word, and PDF Document
Author: Vedran Miletić