cancel
Showing results for 
Search instead for 
Did you mean: 
dylanwan
Employee
Employee

 

Overview

In this article, you'll learn some helpful tips to use Markdown within Incorta Notebook. Markdown helps you take notes, explain the logic, and insert links, tables, etc. in a notebook making your code more understandable to others. Within Incorta Notebooks a markdown paragraph can use either the Markdown language or the HTML language. 

Getting Started

To use Markdown, change the first line of a Notebook Paragraph to %md.

Markdown paragraphs can be enabled in any type of Materialized View language: SparkSQL, PySpark, Scala, and SparkR.  Below is an example of adding an HTML header.

suxinji_0-1654891276721.gif

Formatting

There is no need to use syntax, you can just start typing regular text, but if you wish to format your text, here are some options available to you:

Headings

 

 

<h1></h1> or #
<h2></h2> or ##
<h3></h3> or ###

 

 

suxinji_0-1654901583092.png

suxinji_1-1654901589923.png

Bold

 

 

**  **

 

 

Italics

 

 

*  *

 

 

Bold and Italics

 

 

*** ***

 

 

suxinji_2-1654901643963.png

suxinji_3-1654901655376.png

Ordered List

By starting a line with a number, you can create an ordered list.

1. First item
2. Second item
3. Third item

suxinji_0-1659742350885.png

Unordered List

By starting the line with the dash, you can create an unordered list.

- First item
- Second item
- Third item

suxinji_1-1659742363046.png

Block Quotes

You can add block quotes to your markdown paragraphs. 

To create a block quote, add > in the front of the paragraph. 

suxinji_2-1659742471952.png

suxinji_3-1659742482159.png

Code Blocks

If you have code that you would like to show in the markdown, you can use one back quote or three back quotes. 

 

 

`code here`

 

 

or

 

 

``` 
code here
```

 

 

suxinji_4-1659743718956.png

The output looks like:

suxinji_5-1659743758988.png

Links

Markdown language supports the following format for links:

 

 

[Link text](https://link-url.org)

 

 

If you do not wish to use link text, you don't have to use the syntax, just copy the link in a paragraph.

suxinji_4-1654901206291.png

suxinji_5-1654901219171.png

Spoiler
Note: By default, when you open a link with a left click, it will open in the same notebook window and your notebook will be broken.

We recommend you right mouse click and Open Link in New Tab:

suxinji_1-1659744695537.png

To avoid clicking it open in a tab, you can use this HTML syntax to open the link on a new browser tab. 

 

 

<a href="https://link-url.org" target="_blank">Link text</a>

 

 

suxinji_0-1659745624581.png

suxinji_1-1659745631943.png

Best Practices Index
Best Practices

Just here to browse knowledge? This might help!

Contributors
Version history
Last update:
‎08-08-2022 11:38 AM
Updated by: