JupyterLab extension-cookiecutter-ts
A cookiecutter template for creating a JupyterLab extension. Three kinds of extension are supported:
- frontend: Pure frontend extension written in TypeScript.
- server: Extension with frontend (in TypeScript) and backend (in Python) parts.
- theme: Theme for JupyterLab (using CSS variables).
See also extension-cookiecutter-js for an extension in CommonJS.
Use the template to create package
Install cookiecutter.
pip install cookiecutter
Use cookiecutter to generate a package, following the prompts to fill in the name and authorship of your new JupyterLab extension.
cookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts
If you'd like to generate a package for a specific JupyterLab release, use the --checkout option and give a tag or commit from this repository.
cookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout v1.0
cookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout v2.0
A simple example
Your new extension includes a very simple example of a working extension. Use this example as a guide to build your own extension. Have a look at the extension examples repository for more information on various JupyterLab features.