Skip to main content

Configure a Markdown widget

Apart from the metadata visualizations, your report can include notes or explanations. Configure a Markdown widget and add images, links, tables, and more using the Markdown formatting.

Add a widget​

To add a Markdown widget to your report:

  1. In the top toolbar, click New widget and select Markdown.

  2. To add text, double click the widget.

    For supported formatting options, see Syntax reference.

  3. To resize the widget, click and drag its bottom right corner.

Export a widget​

When ready, you can export the Markdown widget to a new or existing report. To access the export options, open the widget menu ().

Syntax reference​

The following formatting options are supported:

Italic

*Italic*
_Italic_

Bold

**Bold**
__Bold__

strikethrough text

~~strikethrough~~ text

Blockquote

> Blockquote

Inline code

Inline `code`
# code block

from neptune_scale import Run
```
# code block

from neptune_scale import Run
```

Heading 1

Heading 2

...

# Heading 1
## Heading 2
...
Heading 1
=========

Heading 2
---------
...

Horizontal line

Horizontal line
---
Horizontal line
***

Link

[Link](http://neptune.ai)
[Link][1]
...
[1]: http://neptune.ai 

![Image](http://url/a.png) 
![Image][1]
...
[1]: http://url/a.png
  • List item
  • List item
  • List item
* List item
* List item
* List item
- List item
- List item
- List item
  1. First item
  2. Second item
  3. Third item
1. First item
2. Second item
3. Third item
1) First item
2) Second item
3) Third item
  • Task completed
  • Task to do
- [x] Task completed
- [ ] Task to do
Table headerTable header
CellCell
| Table header | Table header |
| ------------ | ------------ |
| Cell         | Cell         |