tongshuangwu / jupyter-renderers

Renderers and renderer extensions for JupyterLab

Jupyter Renderers

This is a monorepo that consists of generic renderers for common file types and mime types as well as renderer extensions for JupyterLab.

Packages

Name	Mime types	File extensions
fasta-extension	application/vnd.fasta.fasta	.fasta
geojson-extension	application/geo+json	.geojson, .geo.json
katex-extension	N/A	N/A
plotly-extension	application/vnd.plotly.v1+json	.plotly, .plotly.json
vega3-extension	application/vnd.vega.v3+json, application/vnd.vegalite.v2+json	.vg, .vl, .vg.json, .vl.json, .vega, .vegalite

Install

• fasta-extension: jupyter labextension install @jupyterlab/fasta-extension
• geojson-extension: jupyter labextension install @jupyterlab/geojson-extension
• katex-extension: jupyter labextension install @jupyterlab/katex-extension
• plotly-extension: jupyter labextension install @jupyterlab/plotly-extension
• vega3-extension: jupyter labextension install @jupyterlab/vega3-extension

Contributing

Developer install

Requires the yarn package manager.

git clone https://github.com/jupyterlab/jupyter-renderers.git
cd jupyter-renderers
yarn install
yarn run build

Link extensions with JupyterLab

Link geojson-extension:

jupyter labextension link packages/geojson-extension

Link all extensions in packages:

yarn run link

Rebuilding extensions

After making changes to the source packages, the packages must be rebuilt:

# Rebuild the source
yarn run build

# Rebuild the JupyterLab staging directory
jupyter lab build

You may also watch the jupyter-renderers directory for changes and automatically rebuild:

# In one terminal tab, watch the jupyter-renderers directory
yarn run watch

# In another terminal tab, run jupyterlab with the watch flag
jupyter lab --watch

Publishing packages

yarn run publish
# If publishing a package for the first time
npm access public @jupyterlab/<extension name>