Skip to content

Commit

Permalink
Initial commit, launcher extensions experiments
Browse files Browse the repository at this point in the history
  • Loading branch information
santilland committed Feb 12, 2020
1 parent da624c6 commit 2cc71f5
Show file tree
Hide file tree
Showing 12 changed files with 3,363 additions and 1 deletion.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*.bundle.*
lib/
node_modules/
*.egg-info/
.ipynb_checkpoints
*.tsbuildinfo
55 changes: 54 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,55 @@
# exampleLoader
Testing jupyterlab customization

![Github Actions Status](https://github.com/my_name/myextension/workflows/Build/badge.svg)

Example loader widget to allow visualization and selection of available example notebooks


## Requirements

* JupyterLab >= 1.0

## Install

```bash
jupyter labextension install exampleLoader
```

## Contributing

### Install

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

```bash
# Clone the repo to your local environment
# Move to exampleLoader directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
```

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.

```bash
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
```

### Uninstall

```bash
jupyter labextension uninstall exampleLoader
```

Loading

0 comments on commit 2cc71f5

Please sign in to comment.