https://github.com/datalayer-examples/jupyterlab-extensions-example
🪐 JupyterLab extensions example.
https://github.com/datalayer-examples/jupyterlab-extensions-example
example extension jupyterlab
Last synced: 3 months ago
JSON representation
🪐 JupyterLab extensions example.
- Host: GitHub
- URL: https://github.com/datalayer-examples/jupyterlab-extensions-example
- Owner: datalayer-examples
- License: other
- Created: 2022-09-17T13:16:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-05T13:13:27.000Z (over 1 year ago)
- Last Synced: 2024-05-05T14:27:06.848Z (over 1 year ago)
- Topics: example, extension, jupyterlab
- Language: TypeScript
- Homepage: https://jupyter-ui.datalayer.tech
- Size: 6.7 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://datalayer.io)
[](https://github.com/sponsors/datalayer)
# JupyterLab Extensions Example
> Example to better understand how to extend JupyterLab.
[](https://mybinder.org/v2/gh/datalayer-examples/jupyterlab-extensions-example/main?urlpath=lab) [](https://github.com/datalayer-examples/jupyterlab-extensions-example/actions/workflows/build.yml)
The audience of this repository is JupyterLab extension developers and is a complement, not a replacement, to these other resources:
- The official [Read The Docs](https://jupyterlab.readthedocs.io/en/latest) documentation. The complete reading of that documentation is a prerequisite before digging more into the content present here. A special attention should be given to the [Develop Extension](https://jupyterlab.readthedocs.io/en/latest/extension/extension_dev.html) section.
- The [extension examples](https://github.com/jupyterlab/extension-examples) repository. That repository contains many different extensions which cover each one specific feature, whereas this repository contains one extension that provides many features.
- The [astronomy picture of the day extension](https://github.com/jupyterlab/jupyterlab_apod) documented on [this page](https://jupyterlab.readthedocs.io/en/stable/extension/extension_tutorial.html).
This repository has been bootstrapped with the [JupyterLab extension cookiecutter](https://github.com/jupyterlab/extension-cookiecutter-ts) with the following command and update to take into account JupyterLab 4.
```bash
cookiecutter \
https://github.com/jupyterlab/extension-cookiecutter-ts \
--checkout 3.0
```
It is composed of a Python package named `jupyterlabextensions` for the server extension and a NPM package named `jupyterlabextensions` for the frontend extension. This repository is updated to track the latest JupyterLab 4 work. This means it will not work fine for previous versions of JupyterLab.
## Documentation
Follow the documentation to use and learn more on the internals of this extension.
- [Concepts](./docs/concepts.md)
- [Setup the Environment](./docs/env.md)
- [Develop the Extensions](./docs/dev.md)
- [Lumino Application](./docs/app-lumino.md)
- [JupyterLab Application](./docs/app-jupyterlab.md)
- [Application Plugins](./docs/plugins-application.md)
- [Theme Plugins](./docs/plugins-theme.md)
- [Mime Renderer Plugins](./docs/plugins-mime-renderer.md)
- [Lint the Source](./docs/lint.md)
- [Test the JavaScript](./docs/test-js.md)
- [Test the Server](./docs/test-server.md)
- [Integration Tests](./docs/test-integration.md)
- [Continuous Integration](./docs/ci.md)
- [Build JupyterLab](./docs/build-jupyterlab.md)
- [Release](./docs/release.md)
- [Notebook 7 Compatibility](./docs/notebook7.md)
- [FAQ](./docs/faq.md)
## ⚖️ License
Copyright (c) 2022 Datalayer, Inc.
Released under the terms of the BSD-3 license (see [LICENSE](./LICENSE)).
PS: To avoid duplicate content, we try to sit in the top-right quadrant of the `HOW TO GUIDES`.
_Source of the image: https://documentation.divio.com_