Skip to content

Commit 2cc71f5

Browse files
committed
Initial commit, launcher extensions experiments
1 parent da624c6 commit 2cc71f5

12 files changed

+3363
-1
lines changed

.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*.bundle.*
2+
lib/
3+
node_modules/
4+
*.egg-info/
5+
.ipynb_checkpoints
6+
*.tsbuildinfo

README.md

+54-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
11
# exampleLoader
2-
Testing jupyterlab customization
2+
3+
![Github Actions Status](https://github.com/my_name/myextension/workflows/Build/badge.svg)
4+
5+
Example loader widget to allow visualization and selection of available example notebooks
6+
7+
8+
## Requirements
9+
10+
* JupyterLab >= 1.0
11+
12+
## Install
13+
14+
```bash
15+
jupyter labextension install exampleLoader
16+
```
17+
18+
## Contributing
19+
20+
### Install
21+
22+
The `jlpm` command is JupyterLab's pinned version of
23+
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
24+
`yarn` or `npm` in lieu of `jlpm` below.
25+
26+
```bash
27+
# Clone the repo to your local environment
28+
# Move to exampleLoader directory
29+
# Install dependencies
30+
jlpm
31+
# Build Typescript source
32+
jlpm build
33+
# Link your development version of the extension with JupyterLab
34+
jupyter labextension link .
35+
# Rebuild Typescript source after making changes
36+
jlpm build
37+
# Rebuild JupyterLab after making any changes
38+
jupyter lab build
39+
```
40+
41+
You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
42+
43+
```bash
44+
# Watch the source directory in another terminal tab
45+
jlpm watch
46+
# Run jupyterlab in watch mode in one terminal tab
47+
jupyter lab --watch
48+
```
49+
50+
### Uninstall
51+
52+
```bash
53+
jupyter labextension uninstall exampleLoader
54+
```
55+

0 commit comments

Comments
 (0)