Skip to content

Commit 3ae8e38

Browse files
authored
update README.md (#51)
1 parent abe0062 commit 3ae8e38

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,27 @@
44

55
Quickly open a file in JupyterLab by typing part of its name
66

7-
![Animation showing entering partial filenames in the quick open sidebar and the corresponding file editor opening](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-quickopen/master/doc/quickopen.gif)
7+
https://github.com/user-attachments/assets/77567c89-ad52-4be8-b0e4-612700353242
88

99
## Compatibility
1010

1111
- Python >=3.8.x
12-
- [JupyterLab](https://github.com/jupyterlab/jupyterlab) >=3.2,<4.0
13-
- [Jupyter Server](https://github.com/jupyter/jupyter_server) >=1.6,<2.0
12+
- [JupyterLab](https://github.com/jupyterlab/jupyterlab) >=3.2
13+
- [Jupyter Server](https://github.com/jupyter/jupyter_server) >=2.4
1414
- Configurations where notebook documents and other files reside on a filesystem local to the
1515
Jupyter Server (which is the the default), not remote storage (e.g., S3)
1616

17-
## Install
17+
## Usage
18+
19+
After installing the extension, you can open the quick open panel by pressing `Ctrl Shift P` (or `Cmd P` on macOS). Start typing the name of the file you want to open, and the quick open panel will show a list of files that match the text you've typed.
20+
21+
https://github.com/user-attachments/assets/77567c89-ad52-4be8-b0e4-612700353242
1822

19-
Starting in version 1.0 of this extension, the frontend portion of this extension is pre-compiled
20-
and included in the `pip` installed package thanks to [changes in the JupyterLab 3.0 packaging
21-
system](https://jupyterlab.readthedocs.io/en/stable/getting_started/changelog.html#extensions-can-be-installed-without-building-jupyterlab-with-nodejs).
23+
The extension also works in Jupyter Notebook 7:
2224

23-
To install the Jupyter Notebook server extension under `PREFIX` (e.g., the active virtualenv or conda
24-
env), run the following:
25+
https://github.com/user-attachments/assets/49147847-2b98-4016-8a11-5d0e8d9749e1
26+
27+
## Install
2528

2629
```bash
2730
pip install jupyterlab-quickopen

0 commit comments

Comments
 (0)