Skip to content

Commit 28fbbad

Browse files
authored
Merge pull request #376 from jlewis91/patch-3
Add Vegalite / Jupyterlab disclaimer
2 parents 580da47 + d949291 commit 28fbbad

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ To install [VegaLite.jl](https://github.com/queryverse/VegaLite.jl), run the fol
4343

4444
The current documentation can be found [here](https://queryverse.github.io/VegaLite.jl/stable).
4545

46+
## Note for Jupyterlab Users
47+
48+
[VegaLite.jl](https://github.com/queryverse/VegaLite.jl) can be used in combination with many different front end clients including [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), [Pluto.jl](https://github.com/fonsp/Pluto.jl), and [Julia for VSCode](https://www.julia-vscode.org).
49+
50+
**Important:** [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) supplies its own version of [Vega-Lite](https://vega.github.io/vega-lite/) and *cannot* be kept in perfect sync with [VegaLite.jl](https://github.com/queryverse/VegaLite.jl). Formatting discrepancies **can** and **will** arise on occasion for [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) users. [VegaLite.jl](https://github.com/queryverse/VegaLite.jl) targets the latest available minor release of [Vega-Lite](https://vega.github.io/vega-lite/) which is also supported by [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/).
51+
4652
## Developer Notes
4753

48-
Jupyterlab support depends on Juperlab's built-in renderer; before updating to a new major version of vega-lite, check the [jupyterlab project](https://github.com/jupyterlab/jupyterlab/blob/master/packages/vega5-extension/package.json#L42) for the latest supported version of vega-lite.
54+
JupyterLab support depends on Juperlab's built-in renderer; before updating to a new major version of vega-lite, check the [JupyterLab project](https://github.com/jupyterlab/jupyterlab/blob/master/packages/vega5-extension/package.json#L42) for the latest supported version of vega-lite.

0 commit comments

Comments
 (0)