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 |
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
Contributing
Developer install
git clone https://github.com/jupyterlab/jupyter-renderers.git
cd jupyter-renderers
npm install
npm run build
Link extensions with JupyterLab
Link geojson-extension:
jupyter labextension link packages/geojson-extension
Link all extensions in packages
:
npm run link
Rebuilding extensions
After making changes to the source of the extension or renderer packages, the packages must be rebuilt:
# Rebuild the source
npm 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
npm run watch
# In another terminal tab, run jupyterlab with the watch flag
jupyter lab --watch
Publishing packages
npm run publish
# If publishing a package for the first time
npm access public @jupyterlab/<extension name>