Skip to content

Commit 94067b9

Browse files
committed
Update the main README for JupyterLab 3
1 parent cf61326 commit 94067b9

File tree

1 file changed

+33
-10
lines changed

1 file changed

+33
-10
lines changed

README.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,41 @@ The goal of this repository is to show how to develop extensions for [JupyterLab
1010
To get started:
1111

1212
```bash
13-
git clone https://github.com/jupyterlab/extension-examples.git jupyterlab-extension-examples && \
14-
cd jupyterlab-extension-examples && \
15-
conda env create && \
16-
conda activate jupyterlab-extension-examples && \
17-
cd basics/hello-world && \
18-
jlpm && \
19-
jlpm run build && \
20-
jupyter labextension install . && \
21-
jupyter lab
13+
# clone the repository
14+
git clone https://github.com/jupyterlab/extension-examples.git jupyterlab-extension-examples
15+
16+
# go to the extension examples folder
17+
cd jupyterlab-extension-examples
18+
19+
# create a new environment
20+
conda env create
21+
22+
# activate the environment
23+
conda activate jupyterlab-extension-examples
24+
25+
# go to the hello world example
26+
cd basics/hello-world
27+
28+
# install the extension in editable mode
29+
python -m pip install -e .
30+
31+
# install your development version of the extension with JupyterLab
32+
jupyter labextension develop . --overwrite
33+
34+
# build the TypeScript source after making changes
35+
jlpm run build
36+
37+
# start JupyterLab
38+
jupyter lab
2239
```
2340

24-
The examples currently target **JupyterLab 2.x**. If you would like to use the examples with JupyterLab 1.x, check out the [1.x branch](https://github.com/jupyterlab/extension-examples/tree/1.x). Note that the `1.x` branch is not updated anymore.
41+
The examples currently target **JupyterLab 3.x**.
42+
43+
If you would like to use the examples with JupyterLab 2.x, check out the [2.x branch](https://github.com/jupyterlab/extension-examples/tree/2.x).
44+
45+
If you would like to use the examples with JupyterLab 1.x, check out the [1.x branch](https://github.com/jupyterlab/extension-examples/tree/1.x).
46+
47+
Note that the `1.x` and `2.x` branches are not updated anymore.
2548

2649
## Develop by Examples
2750

0 commit comments

Comments
 (0)