lessons

Laboratory documentation with Markdown

View material

This course introduces the basics of Markdown, a lightweight markup language used to format plain text in documents. Markdown plays a crucial role in scientific research by enabling the efficient writing of reports, code documentation, and creating well-organised research notebooks. Students will learn essential Markdown syntax throughout the course, including formatting text, adding links, images, tables, math equations, and code blocks. By integrating Markdown with Jupyter Notebook, participants can build dynamic laboratory notebooks that streamline the documentation, analysis, and sharing of research findings.

DOI: https://doi.org/10.5281/zenodo.14016131

Licence: Creative Commons Attribution 4.0 International

Keywords: Markdown, Jupyter Notebook, Data Management

Target audience: Beginner

Resource type: lessons

Version: 1.0

Status: Active

Learning objectives:

  • Understand and utilise Markdown's basic (text, lists) and advanced (images, tables, codes, mathematical expressions) syntax
  • Create a functional digital laboratory notebook that can be adapted for various research projects
  • Recognise other use cases for Markdown in the scientific workflow (e.g., GitHub, R Markdown, Colab)

Date created: 2024-10-30

Date modified: 2024-10-30

Date published: 2024-11-01

Authors: Heleri Inno

Scientific topics: Laboratory information management

Activity log