Skip to main content

A markdown kernel for Jupyter

Project description

Anaconda-Server Badge PyPI version

A markdown kernel for Jupyter

Installation

If you are using a conda environment, you can install markdown-kernel with command

conda install -c conda-forge markdown-kernel

Otherwise, with a working Jupyter installation, you can install markdown-kernel with commands

pip install markdown-kernel
python -m markdown_kernel.install

You can verify if a markdown kernel is properly installed with command

jupyter kernelspec list

Use a markdown kernel by itself

markdown-kernel is a simple Jupyter kernel that displays cell content as markdown. To use this kernel, you can start a Jupyter server with command jupyter notebook or jupyter lab, create a notebook with this kernel, enter and render markdown texts.

image

But wait, this is stupid because you can do the same thing in Jupyter, only easier. What is the point of a markdown kernel by itself?

Use a Markdown kernel in SoS Notebook

If you are familiar with R Markdown, you might know and like its inline code that allows results to be inserted directly into the text of a .Rmd file by enclosing the code with `r `. This is really convenient for writing Rmarkdown report but cannot be done in Jupyter because Jupyter's markdown cells are rendered at the frontend and do not interact with Jupyter kernels (See ipython/ipython#2592, jupyter/help#41,and jupyter/notebook#3463 for related discussions).

SoS Notebook is a Jupyter kernel that supports the use of multiple kernels in one Jupyter notebook. Although a markdown kernel by itself cannot interpolate and evaluate expressions either, you can the %expand magic of SoS to enable inline expressions in Jupyter, for Python, R, and potentially many other languages. Here is how it works:

Expand expressions with SoS (Python) variables

The SoS kernel is a super kernel that starts and communicates with all other Jupyter kernels. Its syntax is a super set of Python 3.6+ so you can execute any Python code in SoS kernels. The %expand magic treats the content of a markdown cell as a Python f-string and expands expressions enclosed in { }, or other delimiters as option of magic %expand.

image

NOTE: Starting from jupyterlab-sos version 0.6.3, the input of codecell with Markdown kernel are folded automatically after cell execution.

Expand expressions in subkernels such as R

The --in option of magic %expand allows you to expand the cell content in specified subkernel, if its language module supports the expand protocol. This allows the content in markdown cells to be expanded in other languages such as R. Most notably, you can use

%expand `r ` --in R

to expand inline expressions in R Markdown texts.

image

This technique is used by sos-rmarkdown, a RMarkdown to SoS Notebook converter to convert markdown text with inline expressions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for markdown-kernel, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size markdown_kernel-0.2.2-py3-none-any.whl (7.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size markdown-kernel-0.2.2.tar.gz (7.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page