Sign inGet started
← Back to all guides

Cheat sheet for markdown in Deepnote notebooks

By Filip Žitný

Updated on March 6, 2024

Markdown is a lightweight markup language that allows you to format text quickly and easily. In Deepnote, Markdown is particularly useful for creating well-structured and visually appealing documentation directly within your notebooks. Here’s a comprehensive cheat sheet to help you master Markdown in Deepnote:

Headings

Markdown supports six levels of headings, which you can create using hash symbols (#) or underline styles for H1 and H2:

# H1
## H2
### H3
#### H4
##### H5
###### H6

Alternatively, for H1 and H2, an underline-ish style:

Alt-H1
======

Alt-H2
------

Text formatting

You can apply various formatting styles to your text:

*Italics*: *asterisks* or _underscores_.
**Bold**: **double asterisks** or __double underscores__.
**Combined**: **asterisks and _underscores_**.
~~Strikethrough~~: ~~double tilde~~

Lists

Markdown supports ordered and unordered lists:

1. First ordered list item
2. Another item
   * Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
   1. Ordered sub-list
4. And another item.

* Unordered list can use asterisks
- Or minuses
+ Or pluses

Links

You can create different types of links:

[Inline link](<https://www.example.com>)
[Inline link with title](<https://www.example.com> "Example Homepage")
[Reference link][link-text]
[Relative reference to a repo file](../blob/master/LICENSE)

URLs and URLs in angle brackets automatically become links: <http://www.example.com>

Images

Display images using Markdown:

Inline-style:  
![Alt text](<http://example.com/image.jpg> "Optional title")

Reference-style:  
![Alt text][image-ref]

[image-ref]: <http://example.com/image.jpg> "Optional title"

Code

Inline code and code blocks can be formatted:

Inline `code` has back-ticks around it.

```javascript
var s = "JavaScript syntax highlighting";
alert(s);
library ieee;
use ieee.std_logic_1164.all;

entity AND_bloc is
    port(x: in std_logic;
         y: in std_logic;
         F: out std_logic
    );
end AND_bloc;

architecture rtl of AND_bloc is
begin
    F <= x and y;
end rtl;
### Tables

Create tables with Markdown:

```markdown
| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned |  1600 |
| col 2 is      | centered      |    12 |

Math equations

You can include LaTeX-style math equations:

Inline math $e^{i\\pi} + 1 = 0$ like this.

$$e^x=\\sum_{i=0}^\\infty \\frac{1}{i!}x^i$$

Blockquotes

Quote text using blockquotes:

> Blockquotes are very handy in email to emulate reply text.

Horizontal rules

Create horizontal rules:

---

***

___

Line breaks

Use double spaces at the end of a line for a line break within a paragraph:

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but  
this line is only separated by a single newline, so it's a separate line in the same paragraph.

Markdown in Deepnote provides a powerful way to document and present your work effectively. With this cheat sheet, you’ll be able to format text, create lists and tables, embed links and images, write code snippets, and even include mathematical equations seamlessly within your Deepnote notebooks. Mastering Markdown can significantly enhance the readability and clarity of your notebooks, making them more accessible and informative for yourself and others. If you encounter any issues, please get in touch with our support. Happy enhancing your notebooks in Deepnote!

Filip Žitný

Data Scientist

Follow Filip on Twitter, LinkedIn and GitHub

That’s it, time to try Deepnote

Get started – it’s free
Book a demo

Footer

Product

  • Integrations
  • Pricing
  • Documentation
  • Changelog
  • Security

Company

Comparisons

Resources

  • Privacy
  • Terms

© Deepnote