Using Markdown for Python

Using Markdown for Python#

Overview#

This beginner-level course introduces the basics of Markdown and how to integrate it with Python. Markdown is a markup language commonly used to format text in a simple and readable way, enabling users to create dynamic documents for reports and documentation. On this course, we will explore dynamic documents, understanding how they work and why they are useful. Through hands-on examples, students will learn how to create, save, and share interactive documents that combine text, code, and output.

This course will be taught using Jupyter Lab but participants are welcome to use any platform or tool they prefer besides Jupyter Lab.

Course Objectives#

  • Understand the benefits of dynamic documents—including how they streamline workflows, enhance reproducibility, and foster collaboration.

  • Navigate and use JupyterLab for creating interactive documents that integrate code and documentation seamlessly.

  • Apply basic Markdown syntax to format text, structure content, and create readable, well-organized documents.

  • Embed Python code within Markdown documents to generate dynamic outputs, such as plots, tables, and results.

  • Create a dynamic document that integrates Python code and Markdown to combine narrative, code, and output into a single cohesive document.

  • Export and save dynamic documents in various formats (e.g., HTML, PDF, Markdown) for sharing, publishing, or printing.

Pre-requisite Knowledge#

Installation guide#

  • All CfRR courses require attendees to use their own computer/laptop to follow workshop activities and take effective notes.

  • Install JupyterLab, ensuring Python and pip are set up on your system. Follow the installation instructions on the CfRR website.

  • Markdown in JupyterLab: No additional installation is needed for basic Markdown support in JupyterLab.

Contents