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.
Last updated
Was this helpful?
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.
Last updated
Was this helpful?
The following link contains a Markdown cheat sheet that summarizes the most important markups we can use:
You can create headings in Markdown using the hashtag symbol:
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:
You can create simple lists using the minus symbol. Nested lists are also possible by adding a tab:
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.
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:
