Markdown Jupyter Notebook

broken image


Oct 14, 2020 Text cells in Jupyter support the Markdown language and we are going to take a look at the facilities that it offers. Markdown is a set of simple markup codes that are easily transformed into HTML for rendering in a browser. This is because of a bug in the Jupyter source where the Markdown alignment is not taken into account and all of the text is right aligned. See the Github issue here: However, it does work using jupyterlab as. Jupyter Book uses MathJax for typesetting math in your HTML book build. This allows you to have LaTeX-style mathematics in your online content. This page shows you a few ways to control this. Just like with Jupyter, you can also work interactively with your R Markdown notebooks. It works a bit differently from Jupyter, as there are no real magic commands; To work with other languages, you need to add separate Bash, Stan, Python, SQL or Rcpp chunks to the notebook.

The Jupyter Notebook Interface

When a new Jupyter notebook opens, you will see the Jupyter notebook interface. Across the top of the notebook you see the Jupyter icon and the notebook name. You can click on the notebook name field and change the name of the notebook. Note that the file extension .ipynb is not printed in the file name field, but if you look in the Home tab, you will see that the notebook is saved with the .ipynb extension.

Menus and Buttons

A Jupyter notebook is comprised of a bunch of cells which are arrayed one after another in boxes below the menu items and buttons. There are three main types of cells: code cells, output cells, and markdown cells.

Code Cells

In code cells, you can write Python code, then execute the Python code and see the resulting output. An example of a code cell is shown below.

You can tell you are typing in a code cell because In [ ]: is shown to the left of the cell and the cell-type drop-down menu shows Code.

Notebook

To run the Python code in a code cell push the [Run] button or type [Shift]+[Enter]. Hitting [Enter] when the cursor is inside a code cell brings the cursor down to a new line.

Output Cells

After a code cell is run, an output cell can be produced below the code cell. The output cell contains the output from the code cell above it. Not all code produces output, so not all code cells produce output cells. The results in output cells can't be edited. If a code cell produces plots, charts or images, these outputs are shown in output cells.

You can clear all the output cells and re-run code cells by selecting [Kernal] --> [Restart Kernal and Clear Output].

Markdown Cells

Markdown cells don't contain Python code. Markdown cells contain text written in Markdown format. Text in markdown cells can be formatted to show bold or italic text. Tables, images, and lists can also be included in markdown cells.

Markdown cells are used for documentation and explaining your code. The text in a markdown cell is not executed. Markdown cells can be formatted with a few special characters.

Markdown cells are run like code cells. The difference is that when markdown cells are run, the text is formatted (when code cells run, code is executed). Markdown cells are run by clicking the [Run] button or by pressing [Shift] + [Enter].

Text in markdown cells can be formatted using markdown syntax. An example of markdown syntax is putting an underscore before and after a word to cause the word to be formatted in italics.

Headings

Headings are created in markdown cells using the hash symbol #. One # is the largest heading. Four hashes #### is the smallest heading.

Code Blocks

Code blocks can be inserted in Jupyter notebook markdown cells. For inline code blocks use the ` left quote character, the character to the left of the number [1] and above [Tab] on most keyboards.

This is inline code: ` ` ` Inline code block ` ` ` within a paragraph

For a separated code block use three ` left quote characters on one line, followed by the code block on separate lines. Terminate the separate code block with a line of three ` left quote characters.

```

Separated code block

```

The code in markdown cell code blocks do not execute when the markdown cell is run. A code block in a markdown cell is formatted when the markdown cell executes.

Bold and Italics

Bold and italic font is displayed by surrounding text with a double asterisk for **bold** and a single underscore for _italics_

Markdown

Markdown Jupyter Notebook Tab

**bold** produces bold

_italics_ produces italics

**_bold and italic_** produces bold and italic

Tables

Tables are displayed using the pipe | character, which is [Shift] + [] on most keyboards. Columns are separated by pipes | and rows are separated by lines. After the header row, a row of pipes and dashes --- are needed to define the table.

produces:

header1header 2header 3
col 1col 2col 3
col 1col 2col 3

Bullet Points and Lists

Bullet points are produced using the asterisk character *

produces

  • item 1
  • item 2
  • item 3

Numbered lists are produced using sequential numbers followed by a dot. Indent sub-items with two spaces.

produces

  1. First item
  2. Second item
  3. Third item
  4. sub item
  5. sub item
    1. sub-sub item
    2. sub-sub item

Horizontal Rule

A horizontal rule is specified with three asterisks *** on a single line.

produces

Links

Hyperlinks are specified using a set of square brackets [ ] followed by a pair of parenthesis ( ) The text inside the square brackets will be the link, the link address goes in the parenthesis.

produces

Images

Images are embedded in Jupyter Notebook markdown using the exclamation point and square brackets ![ ], followed by the image file path in parenthesis ( ). If the image can not be displayed, the text in square brackets will be shown. The image can be in the same directory as the notebook, or a relative path can be specified. In this case, the image engineering.png is stored in the images directory, which is a subdirectory of the directory the notebook is saved in.

displays the image

LaTeX Math

Cisco anyconnect install command. LaTeX Math equations and symbols are rendered by markdown cells. A more extensive list of LaTeX commands can be found in the appendix.

produces

html

Because Jupyter notebooks are rendered by web browsers, just about any HTML tag can be included in the markdown portion of a notebook. An example of an HTML tag is the tags that surround superscript text.

produces

x2

Text can be colored using html tags

produces

Red Text

Warning Boxes

bootstrap style warning boxes can be included in Jupyter notebook markdown using

tags

produces

Warning! Python lists start at 0

Creating a new cell

You can create a new cell in a Jupyter Notebook by clicking the [+] button in the upper menu. Clicking the [+] button produces a new code cell below the active cell.

You can also create a new cell using Insert --> Insert Cell Above or Insert Cell Below. You can choose to insert a cell above or below the active cell.

Changing the cell type

The type of cell: code cell or markdown cell, is changed by clicking on a cell and selecting the cell type from the drop-down menu. Typing [Esc] + [m] changes the cell type to a markdown cell. Typing [Esc] + [y] changes the cell type to a code cell.

Saving a Jupyter Notebook

Download

Jupyter notebooks can be saved using the save icon in the upper menu or by pressing [Ctrl] + [s].

Jupyter notebooks can also be saved as a copy, similar to the Save As command common in many programs. To save a copy of a Jupyter notebook use File --> Make a Copy..

Renaming a Jupyter Notebook

Jupyter notebooks are renamed by clicking on the notebook name above the upper menu and typing a new name into the dialog box.

Downloading a Jupyter Notebook

Jupyter notebooks can be downloaded and saved using File --> Download As --> Notebook (.ipynb). Selecting this menu option will download the notebook as a .ipynb file.

Note that when a .ipynb file is viewed in a text editor like notepad, the notebook is unformatted and looks like a confusing jumble of text. The notebook needs to be opened in a Jupyter notebook file browser in order for the code in the notebook to run and the markdown text to render.

Saving Jupyter Notebooks in Other Formats

Jupyter notebooks can be saved in other formats besides the native .ipynb format. These formats can be accessed using the [File] --> [Download As] menu.

The available file download types are:

  • Notebook (.ipynb) - The native jupyter notebook format
  • Python (.py) - The native Python code file type.
  • HTML (.html) - A web page
  • Markdown (.md) - Markdown format
  • reST (.rst) - Restructured text format
  • LaTeX (.tex) - LaTeX Article format
  • PDF via LaTeX (.pdf) - a pdf exported from LaTeX, requires a converter

When a notebook is saved as a .py file, all text in markdown cells is converted to comments, and any code cells stay intact as Python code.

Learning Objectives

Markdown Jupyter Notebook New Line

After completing this page, you will be able to:

  • Create new Code and Markdown cells within Jupyter Notebook.
  • Run Code and Markdown cells within Jupyter Notebook to execute Python code and render Markdown text.
  • List useful shortcuts for common tasks in Jupyter Notebook.

Work With Python Code and Markdown Cells in Jupyter Notebook

Recall that a Jupyter Notebook file consists of a set of cells that can store text or code.

  • Text Cells: Text cells allow you to write and render Markdown syntax. This is where you can describe and document your workflow.
  • Code Cells: Code cells allow you to write and run programming code (e.g. Python).

Create New Cells

You can use either the Menu tools or Keyboard Shortcuts to create new cells.

FunctionKeyboard ShortcutMenu Tools
Create new cellEsc + a (above), Esc + b (below)Insert→ Insert Cell Above OR Insert → Insert Cell Below
Copy CellcCopy Key
Paste CellvPaste Key

While the default cell type for new cells is Code, you can change the cell type of any existing cell by clicking in the cell and selecting a new cell type (e.g. Markdown) in the cell type menu in the toolbar.

Cell type options include Code, Markdown, Raw NBConvert (for text to remain unmodified by nbconvert), and Heading.

To use the Keyboard Shortcuts, hit the esc key. Adobe after effects mediafire. After that, you can change a cell to Markdown by hitting the m key, or you can change a cell to Code by hitting the y key.

Run Cells

Python Code Cells

You can run any cell in Jupyter Notebook (regardless of whether it contains Code or Markdown) using the Menu tools or Keyboard Shortcuts.

FunctionKeyboard ShortcutMenu Tools
Run CellCtrl + enterCell → Run Cell

For example, you can add a new Code cell and then run the following Python code (e.g. 3 + 4). Your result, or output, will be displayed below the Code cell that you run.

Markdown Cells

You can run Markdown cells in the same way that you can run code cells. However, when you run a Markdown cell, the text formatted using Markdown syntax will be rendered as stylized text.

This means that headings are larger and bold, bulleted lists have bullets next to them instead of *, and regular text looks normal. No outputs will appear below the Markdown cell.

For example, the Markdown syntax below represents 3 headers. You can double-click in any Markdown cell to see the raw Markdown syntax, which for the cell below would appear like this raw Markdown syntax:

To see the Markdown as stylized text, run the cell. It should look like the text printed below:

This is a subtitle in Markdown

This is a smaller subtitle

This is an even smaller subtitle

Rearrange Cells in a Jupyter Notebook

You can change the order of cells within Jupyter Notebook using the up arrow and down arrow buttons on the menu bar. To do this, click inside the cell that you want to move and then press the desired arrow as many times as you need to move the Cell to the desired location.

Clear Results in Jupyter Notebook

Sometimes, you may want to clear any output results that have been produced. You can do this using the Menu:

Menu Tools
Cell -> Current Outputs -> Clear

This will clear the current cell that you are working in, which you can activate by clicking in a cell.

Markdown Jupyter Notebook

You can also clear all of the output using the Menu Tools.

Markdown

To run the Python code in a code cell push the [Run] button or type [Shift]+[Enter]. Hitting [Enter] when the cursor is inside a code cell brings the cursor down to a new line.

Output Cells

After a code cell is run, an output cell can be produced below the code cell. The output cell contains the output from the code cell above it. Not all code produces output, so not all code cells produce output cells. The results in output cells can't be edited. If a code cell produces plots, charts or images, these outputs are shown in output cells.

You can clear all the output cells and re-run code cells by selecting [Kernal] --> [Restart Kernal and Clear Output].

Markdown Cells

Markdown cells don't contain Python code. Markdown cells contain text written in Markdown format. Text in markdown cells can be formatted to show bold or italic text. Tables, images, and lists can also be included in markdown cells.

Markdown cells are used for documentation and explaining your code. The text in a markdown cell is not executed. Markdown cells can be formatted with a few special characters.

Markdown cells are run like code cells. The difference is that when markdown cells are run, the text is formatted (when code cells run, code is executed). Markdown cells are run by clicking the [Run] button or by pressing [Shift] + [Enter].

Text in markdown cells can be formatted using markdown syntax. An example of markdown syntax is putting an underscore before and after a word to cause the word to be formatted in italics.

Headings

Headings are created in markdown cells using the hash symbol #. One # is the largest heading. Four hashes #### is the smallest heading.

Code Blocks

Code blocks can be inserted in Jupyter notebook markdown cells. For inline code blocks use the ` left quote character, the character to the left of the number [1] and above [Tab] on most keyboards.

This is inline code: ` ` ` Inline code block ` ` ` within a paragraph

For a separated code block use three ` left quote characters on one line, followed by the code block on separate lines. Terminate the separate code block with a line of three ` left quote characters.

```

Separated code block

```

The code in markdown cell code blocks do not execute when the markdown cell is run. A code block in a markdown cell is formatted when the markdown cell executes.

Bold and Italics

Bold and italic font is displayed by surrounding text with a double asterisk for **bold** and a single underscore for _italics_

Markdown Jupyter Notebook Tab

**bold** produces bold

_italics_ produces italics

**_bold and italic_** produces bold and italic

Tables

Tables are displayed using the pipe | character, which is [Shift] + [] on most keyboards. Columns are separated by pipes | and rows are separated by lines. After the header row, a row of pipes and dashes --- are needed to define the table.

produces:

header1header 2header 3
col 1col 2col 3
col 1col 2col 3

Bullet Points and Lists

Bullet points are produced using the asterisk character *

produces

  • item 1
  • item 2
  • item 3

Numbered lists are produced using sequential numbers followed by a dot. Indent sub-items with two spaces.

produces

  1. First item
  2. Second item
  3. Third item
  4. sub item
  5. sub item
    1. sub-sub item
    2. sub-sub item

Horizontal Rule

A horizontal rule is specified with three asterisks *** on a single line.

produces

Links

Hyperlinks are specified using a set of square brackets [ ] followed by a pair of parenthesis ( ) The text inside the square brackets will be the link, the link address goes in the parenthesis.

produces

Images

Images are embedded in Jupyter Notebook markdown using the exclamation point and square brackets ![ ], followed by the image file path in parenthesis ( ). If the image can not be displayed, the text in square brackets will be shown. The image can be in the same directory as the notebook, or a relative path can be specified. In this case, the image engineering.png is stored in the images directory, which is a subdirectory of the directory the notebook is saved in.

displays the image

LaTeX Math

Cisco anyconnect install command. LaTeX Math equations and symbols are rendered by markdown cells. A more extensive list of LaTeX commands can be found in the appendix.

produces

html

Because Jupyter notebooks are rendered by web browsers, just about any HTML tag can be included in the markdown portion of a notebook. An example of an HTML tag is the tags that surround superscript text.

produces

x2

Text can be colored using html tags

produces

Red Text

Warning Boxes

bootstrap style warning boxes can be included in Jupyter notebook markdown using

tags

produces

Warning! Python lists start at 0

Creating a new cell

You can create a new cell in a Jupyter Notebook by clicking the [+] button in the upper menu. Clicking the [+] button produces a new code cell below the active cell.

You can also create a new cell using Insert --> Insert Cell Above or Insert Cell Below. You can choose to insert a cell above or below the active cell.

Changing the cell type

The type of cell: code cell or markdown cell, is changed by clicking on a cell and selecting the cell type from the drop-down menu. Typing [Esc] + [m] changes the cell type to a markdown cell. Typing [Esc] + [y] changes the cell type to a code cell.

Saving a Jupyter Notebook

Jupyter notebooks can be saved using the save icon in the upper menu or by pressing [Ctrl] + [s].

Jupyter notebooks can also be saved as a copy, similar to the Save As command common in many programs. To save a copy of a Jupyter notebook use File --> Make a Copy..

Renaming a Jupyter Notebook

Jupyter notebooks are renamed by clicking on the notebook name above the upper menu and typing a new name into the dialog box.

Downloading a Jupyter Notebook

Jupyter notebooks can be downloaded and saved using File --> Download As --> Notebook (.ipynb). Selecting this menu option will download the notebook as a .ipynb file.

Note that when a .ipynb file is viewed in a text editor like notepad, the notebook is unformatted and looks like a confusing jumble of text. The notebook needs to be opened in a Jupyter notebook file browser in order for the code in the notebook to run and the markdown text to render.

Saving Jupyter Notebooks in Other Formats

Jupyter notebooks can be saved in other formats besides the native .ipynb format. These formats can be accessed using the [File] --> [Download As] menu.

The available file download types are:

  • Notebook (.ipynb) - The native jupyter notebook format
  • Python (.py) - The native Python code file type.
  • HTML (.html) - A web page
  • Markdown (.md) - Markdown format
  • reST (.rst) - Restructured text format
  • LaTeX (.tex) - LaTeX Article format
  • PDF via LaTeX (.pdf) - a pdf exported from LaTeX, requires a converter

When a notebook is saved as a .py file, all text in markdown cells is converted to comments, and any code cells stay intact as Python code.

Learning Objectives

Markdown Jupyter Notebook New Line

After completing this page, you will be able to:

  • Create new Code and Markdown cells within Jupyter Notebook.
  • Run Code and Markdown cells within Jupyter Notebook to execute Python code and render Markdown text.
  • List useful shortcuts for common tasks in Jupyter Notebook.

Work With Python Code and Markdown Cells in Jupyter Notebook

Recall that a Jupyter Notebook file consists of a set of cells that can store text or code.

  • Text Cells: Text cells allow you to write and render Markdown syntax. This is where you can describe and document your workflow.
  • Code Cells: Code cells allow you to write and run programming code (e.g. Python).

Create New Cells

You can use either the Menu tools or Keyboard Shortcuts to create new cells.

FunctionKeyboard ShortcutMenu Tools
Create new cellEsc + a (above), Esc + b (below)Insert→ Insert Cell Above OR Insert → Insert Cell Below
Copy CellcCopy Key
Paste CellvPaste Key

While the default cell type for new cells is Code, you can change the cell type of any existing cell by clicking in the cell and selecting a new cell type (e.g. Markdown) in the cell type menu in the toolbar.

Cell type options include Code, Markdown, Raw NBConvert (for text to remain unmodified by nbconvert), and Heading.

To use the Keyboard Shortcuts, hit the esc key. Adobe after effects mediafire. After that, you can change a cell to Markdown by hitting the m key, or you can change a cell to Code by hitting the y key.

Run Cells

Python Code Cells

You can run any cell in Jupyter Notebook (regardless of whether it contains Code or Markdown) using the Menu tools or Keyboard Shortcuts.

FunctionKeyboard ShortcutMenu Tools
Run CellCtrl + enterCell → Run Cell

For example, you can add a new Code cell and then run the following Python code (e.g. 3 + 4). Your result, or output, will be displayed below the Code cell that you run.

Markdown Cells

You can run Markdown cells in the same way that you can run code cells. However, when you run a Markdown cell, the text formatted using Markdown syntax will be rendered as stylized text.

This means that headings are larger and bold, bulleted lists have bullets next to them instead of *, and regular text looks normal. No outputs will appear below the Markdown cell.

For example, the Markdown syntax below represents 3 headers. You can double-click in any Markdown cell to see the raw Markdown syntax, which for the cell below would appear like this raw Markdown syntax:

To see the Markdown as stylized text, run the cell. It should look like the text printed below:

This is a subtitle in Markdown

This is a smaller subtitle

This is an even smaller subtitle

Rearrange Cells in a Jupyter Notebook

You can change the order of cells within Jupyter Notebook using the up arrow and down arrow buttons on the menu bar. To do this, click inside the cell that you want to move and then press the desired arrow as many times as you need to move the Cell to the desired location.

Clear Results in Jupyter Notebook

Sometimes, you may want to clear any output results that have been produced. You can do this using the Menu:

Menu Tools
Cell -> Current Outputs -> Clear

This will clear the current cell that you are working in, which you can activate by clicking in a cell.

You can also clear all of the output using the Menu Tools.

Markdown Jupyter Notebook Vscode

Menu Tools
Cell -> All Output -> Clear
Manage Directories Using Dashboard Jupyter Notebook For Python




broken image