Skip to content

Commit dfdaf03

Browse files
committed
doc: improve README and index
1 parent 4045e6d commit dfdaf03

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Documentation](https://github.com/juba/pyobsplot/actions/workflows/publish.yml/badge.svg)](https://github.com/juba/pyobsplot/actions/workflows/publish.yml)
77
[![Open In Colab](https://github.com/juba/pyobsplot/raw/main/doc/img/colab-badge.svg)](https://colab.research.google.com/github/juba/pyobsplot/blob/main/examples/introduction.ipynb)
88

9-
`pyobsplot` allows to use [Observable Plot](https://observablehq.com/@observablehq/plot?collection=@observablehq/plot) to create charts in [Jupyter](https://jupyter.org) notebooks, [VSCode](https://code.visualstudio.com) notebooks, [Google Colab](https://colab.research.google.com) and [Quarto](https://quarto.org) documents. Plots are created from Python code with a syntax as close as possible to the JavaScript one.
9+
`pyobsplot` allows to use [Observable Plot](https://observablehq.com/@observablehq/plot?collection=@observablehq/plot) to create charts in [Jupyter](https://jupyter.org) or [Marimo](https://marimo.io) notebooks and [Quarto](https://quarto.org) documents. Plots are created from Python code with a syntax as close as possible to the JavaScript one.
1010

1111
It allows to do things like :
1212

@@ -42,7 +42,7 @@ Plot.plot({
4242
pip install pyobsplot[typst]
4343
```
4444

45-
To use `pyobsplot` in [jupyter lite](https://jupyter.org/try-jupyter/lab/) or [marimo](https://marimo.io) you must install it without the `typst` dependency, which is not yet compatible with [pyodide](https://pyodide.org/en/stable/):
45+
To use `pyobsplot` in [JupyterLite](https://jupyter.org/try-jupyter/lab/) or [marimo](https://marimo.io) you must install it without the `typst` dependency, which is not yet compatible with [pyodide](https://pyodide.org/en/stable/):
4646

4747
```sh
4848
pip install pyobsplot
@@ -66,7 +66,7 @@ If you just want to try this package without installing it on your computer, you
6666
- Plots can be generated as Jupyter widgets, or as SVG, HTML or PNG outputs (via typst)
6767
- Plots can be saved to Widget HTML, static HTML, SVG, PNG or PDF files
6868
- [Pandas](https://pandas.pydata.org) and [polars](https://pola.rs) DataFrame and Series objects are serialized using [Arrow](https://arrow.apache.org) IPC format for improved speed and better data type conversions
69-
- Works with Jupyter notebooks, Quarto documents (all renderers), Jupyter lite and Marimo notebooks (widget renderer only)
69+
- Works with Jupyter, JupyterLite and Marimo notebooks as well as in Quarto documents
7070
- Works offline, no iframe or dependency to Observable runtime
7171
- Caching mechanism of data objects if they are used several times in the same plot
7272
- Custom JavaScript code can be passed as strings with the `js` method

doc/index.qmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "pyobsplot"
55

66
## Overview
77

8-
`pyobsplot` allows to use [Observable Plot](https://observablehq.com/@observablehq/plot?collection=@observablehq/plot) to create charts in [Jupyter](https://jupyter.org) notebooks, [VSCode](https://code.visualstudio.com) notebooks, [Google Colab](https://colab.research.google.com) and [Quarto](https://quarto.org) documents. Plots are created from Python code with a syntax as close as possible to the JavaScript one.
8+
`pyobsplot` allows to use [Observable Plot](https://observablehq.com/@observablehq/plot?collection=@observablehq/plot) to create charts in [Jupyter](https://jupyter.org) or [Marimo](https://marimo.io) notebooks and [Quarto](https://quarto.org) documents. Plots are created from Python code with a syntax as close as possible to the JavaScript one.
99

1010

1111
```{python}
@@ -83,7 +83,7 @@ If you just want to try this package without installing it on your computer, you
8383
- Plots can be generated as Jupyter widgets, or as SVG, HTML or PNG outputs (via typst)
8484
- Plots can be saved to Widget HTML, static HTML, SVG, PNG or PDF files
8585
- [Pandas](https://pandas.pydata.org) and [polars](https://pola.rs) DataFrame and Series objects are serialized using [Arrow](https://arrow.apache.org) IPC format for improved speed and better data type conversions
86-
- Works with Jupyter notebooks, Quarto documents (all renderers), Jupyter lite and Marimo notebooks (widget renderer only)
86+
- Works with Jupyter, JupyterLite and Marimo notebooks as well as in Quarto documents
8787
- Works offline, no iframe or dependency to Observable runtime
8888
- Caching mechanism of data objects if they are used several times in the same plot
8989
- Custom JavaScript code can be passed as strings with the `js` method

0 commit comments

Comments
 (0)