Adding Documentation

We can use Markdown in Databricks notebooks to create a structured and formatted documentation alongside our analysis. This article introduces the most important features of Markdown.

The following link contains a Markdown cheat sheet that summarizes the most important markups we can use:

Markdown CheatsheetGitHub

Headings

You can create headings in Markdown using the hashtag symbol:

# This is a heading of first degree
## This is a hedaing of 2nd degree
### This is a heading of 3rd degree

Links

You can create a link in Markdown by putting the linked text in square brackets and the URL to which you want to link in brackets:

The following link takes you somewhere: [Link somewhere](htttps://somewhere.com)

Lists

You can create simple lists using the minus symbol. Nested lists are also possible by adding a tab:

This is a list:

- Top level item
- Another top level item
    - A subitem
    - Another subitem
- Last top level item

Images

You can add images to your notebook by putting an exclamation mark in front of the square brackets, in which you define an alternative text to show if the image can't be displayed. The URL of the image must be put in brackets following the square brackets. Optionally, you can add a title that is shown on hover.

![My image](https://somewhere.com/image.jpg "An image hover title")

Mixing Markdown with HTML

If Markdown isn't enough, you can use HTML within a markdown block as well. One use case for me is to include links in notebooks that open in a new tab:

# This is a heading of first degree
---
Find more information <a href="https://more.info" target="_blank">here</a>.