Skip to main content

Markdown

Type .md in the first line of an input cell

Markdown syntax​

Headings​

Use # for headings, increasing the number of # for smaller headings:

.md
# Heading 1
## Heading 2
### Heading 3

Emphasis​

Use * or _ for italics, and ** or __ for bold:

.md
*italic* or _italic_
**bold** or __bold__

Lists​

Create unordered lists with *, +, or -, and ordered lists with numbers followed by a period:

.md

- Item 1
- Item 2
  - Subitem 1

1. First item
2. Second item
   1. Subitem 1

Create links using [text](URL):

.md
[Tree](https://en.wikipedia.org/wiki/Tree)

Images​

Embed images using ![alt text](URL):

.md
![Tree](https://upload.wikimedia.org/wikipedia/commons/e/eb/Ash_Tree_-_geograph.org.uk_-_590710.jpg)
note

Files can be remote or local (in the notebook folder). Try to drag and drop any image inside markdown cell

Drawings​

We use an amazing Excalidraw editor for any complex drawings right inside the markdown input cell. Try to type

.md

!![]

In the output cell a corresponding SVG image will be generated.

See GIF animation below

Blockquotes​

Create blockquotes using >:

.md
> This is a blockquote.

Code​

Inline code uses backticks, and code blocks are wrapped with triple backticks:

.md

`inline code`

code block

.md

### Horizontal Rule
Create a horizontal rule with three or more dashes, asterisks, or underscores:

```markdown
---
***
___

Tables​

Create tables using pipes | and dashes -:

.md

| Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |
| Cell 3   | Cell 4   |

Highlighter​

Use == wrapper to highlight text, i.e.

.md
==Hello World==

Pure HTML​

One can also use plain HTML tags to stylize markdown or embed media objects

LaTeX​

We use KaTeX as a render engine, to type a equation wrap it inside $ or $$ (for equation block)

.md

$$
E = \\hbar \\omega
$$
warning

Unfortunately, you have to escape all backslashes, i.e. instead of \alpha you need to write \\alpha.

See here all supported function for LaTeX equations.

WLX​

Markdown cells supports many features of WLX similar to how it is done in Slides

Embed figures​

For example you created a nice 3D plot

cell 1
Figure = Plot3D[Sin[x] Cos[y], {x,-5,5}, {y,-5,5}];
tip

Make first letter in the name of a symbol capital, this is required by the syntax of WLX language.

then one can embed it into markdown cell as if it was a custom tag

.md

Hello there! Here is my plot

<br/>

<Figure/>

Autoupload​

Drop a file​

Paste media file​

Github repo To switch to Markdown language use .md prefix on the first line

Last updated on