Jupyter Notebook Markdown Cell



The Jupyter Notebook is an open-source web application that allows you to create and share documents that contain live code, equations, visualizations and narrative text. Uses include: data cleaning and transformation, numerical simulation, statistical modeling, data visualization, machine learning, and much more. The definition copied from the official website.

  1. Jupiter Notebook Markdown Cell Syntax
  2. Jupyter Notebook Markdown Cell Formatting
  3. Jupyter Notebook Markdown Cell New Line
Jupyter

It’s becoming common to use Jupyter notebook to write books, do data analysis, reproducible experiments, etc… The file produced out of notebook follows JSON Schema. Yet to view the file, the user needs to use web-application or local notebook instance or browser instance.

Here is a 20 lines output of a notebook.

“Text can be added to Jupyter Notebooks using Markdown cells. You can change the cell type to Markdown by using the Cell menu, the toolbar, or the key shortcut m.Markdown is a popular markup language that is a superset of HTML.

Cell

When the notebook is refreshed in Jupyter, cell inputs are loaded from the script or Markdown document and kernel variables are preserved. Python - help - jupyter notebook markdown example. The highlights will be saved with the notebook (as cell metadata) but will not be automatically.

It’s hard to follow the content along with the schema. When the code is checked into the repository, it’s hard to view the content from the command line.

Over the weekend, I wrote a small command-line tool to render the notebook over the terminal with help of fantastic python library, rich.

Tool

Jupyter notebook markdown cell color

jut is a command line tool to display jupyter notebook in the terminal. The tool takes in a jupyter notebook file or URL (Raw Github or any ipynb file link) and renders each cell content in the terminal. You can install the package by running pip command pip install jut.

Jupiter Notebook Markdown Cell Syntax

Notebook

Here is a quick asciicinema demo

Usage

Display first five cells

Example: jut --input-file foo.ipynb --head 5

Display last five cells

Example: jut --input-file foo.ipynb --tail 5

Download the file and display first five cells

Example: jut --url https://raw.githubusercontent.com/fastai/fastbook/master/06_multicat.ipynb --head 5

Jupyter Notebook Markdown Cell Formatting

Limitation

The tool only display text content like markdown, python code, python output, raw text, JSON and ignores any multi-media contents like images, PDF documents.

I hope the tool is a useful utility for folks working and handling with the Jupyter notebook. The code is available in GitHub, feel free to file bug report and file feature requests.

References

  • Jupyter Project - https://jupyter.org/
  • Github Page - https://github.com/kracekumar/jut
  • Python Rich Library - https://github.com/willmcgugan/rich
Jupyter

See also

Jupyter Notebook Markdown Cell New Line


This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.