Skip to content

Commit 85c7b9e

Browse files
authored
Use tabs in install docs to make the page more readable (#790)
1 parent 8c689da commit 85c7b9e

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

docs/user_guide/install.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,65 @@
11
# Installing JupyterGIS
22

3+
```````{tabs}
4+
5+
``````{group-tab} Mamba (recommended)
6+
37
:::{note}
48
It is best to install JupyterGIS using `mamba`, `conda`, `micromamba`, or `pixi` since you'll be able to install `qgis` at the same time, allowing you to open `.qgz` files.
59
:::
610
711
```bash
812
mamba install -c conda-forge jupytergis qgis
913
```
14+
``````
15+
16+
``````{group-tab} pip
1017
11-
Alternatively, you can install JupyterGIS with `pip`:
18+
:::{warning}
19+
When installing with `pip`, QGIS compatibility functions won't work out of the box.
20+
You're on your own!
21+
:::
1222
1323
```bash
1424
pip install jupytergis
1525
```
26+
``````
27+
28+
```````
1629

17-
Finally, start JupyterLab:
30+
Once JupyterGIS is installed, start JupyterLab:
1831

1932
```bash
2033
jupyter lab
2134
```
2235

2336
## Quickstart
2437

25-
Here are a few neat options to quickstart in a temporary environment:
38+
Here are a few neat options to quickstart in an ephemeral environment:
39+
40+
```````{tabs}
41+
``````{group-tab} Docker
2642
27-
### [Docker](https://www.docker.com/)
43+
[Docker](https://www.docker.com/)
2844
2945
```bash
3046
docker run -p 8888:8888 ghcr.io/geojupyter/jupytergis:latest
3147
```
48+
``````
3249
33-
### [pixi](https://github.com/prefix-dev/pixi)
50+
``````{group-tab} Pixi
51+
[Pixi](https://github.com/prefix-dev/pixi)
3452
3553
```bash
3654
pixi exec --spec jupytergis --spec qgis jupyter lab
3755
```
56+
``````
3857
39-
### [uv](https://github.com/astral-sh/uv)
58+
``````{group-tab} uv
59+
[uv](https://github.com/astral-sh/uv)
4060
4161
```bash
4262
uv run --with jupytergis jupyter lab
4363
```
64+
``````
65+
```````

0 commit comments

Comments
 (0)