jupyterlab/jupyter-renderers

Name: jupyter-renderers

Owner: JupyterLab

Description: Renderers and renderer extensions for JupyterLab

Created: 2017-06-08 16:59:07.0

Updated: 2018-01-18 06:48:38.0

Pushed: 2018-01-11 11:12:08.0

Homepage:

Size: 368

Language: Jupyter Notebook

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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 |

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.

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

Link extensions with JupyterLab

Link geojson-extension:

ter labextension link packages/geojson-extension

Link all extensions in packages:

 run link

Rebuilding extensions

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

build the source
 run build

build the JupyterLab staging directory
ter lab build

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

 one terminal tab, watch the jupyter-renderers directory
 run watch

 another terminal tab, run jupyterlab with the watch flag
ter lab --watch

Publishing packages

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