https://github.com/jupyterlab/theme-cookiecutter

A cookiecutter template to help you make new JupyterLab theme extensions
https://github.com/jupyterlab/theme-cookiecutter

cookiecutter cookiecutter-template jupyter jupyterlab jupyterlab-extension jupyterlab-theme typescipt

Last synced: 14 days ago
JSON representation

A cookiecutter template to help you make new JupyterLab theme extensions

• Host: GitHub
• URL: https://github.com/jupyterlab/theme-cookiecutter
• Owner: jupyterlab
• License: bsd-3-clause
• Archived: true
• Created: 2019-01-22T20:54:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-01-25T10:36:32.000Z (almost 3 years ago)
• Last Synced: 2024-08-01T16:38:07.343Z (3 months ago)
• Topics: cookiecutter, cookiecutter-template, jupyter, jupyterlab, jupyterlab-extension, jupyterlab-theme, typescipt
• Language: CSS
• Homepage:
• Size: 147 KB
• Stars: 49
• Watchers: 5
• Forks: 19
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# theme-cookiecutter

## Archived

**This project is archived. It is now possible to create a Theme Extension for JupyterLab using the following cookiecutter: https://github.com/jupyterlab/extension-cookiecutter-ts**.

A [cookiecutter](https://github.com/audreyr/cookiecutter) template to help you make new JupyterLab theme extensions.

## Examples

## Usage

Install cookiecutter:

```

pip install cookiecutter

```

Use cookiecutter to generate a package:

```

cookiecutter https://github.com/jupyterlab/theme-cookiecutter

```

## Prompts

The cookiecutter will prompt you with the following questions and generate a project according to your responses:

* `author_name`: Your full name.

* `python_name`: The name of the Python package for your JupyterLab extension (e.g. `jupyterlab_pink_theme`).

* `labextension_name`: Your JupyterLab extension name (e.g. `@my-organization/jupyterlab-pink-theme`).

* `project_short_description`: A short description of your JupyterLab theme extension.

* `has_binder`: Whether you extension has a binder link or not.

* `repository`: Your theme's repository. If the code of your theme is hosted on Github, this should just be the main Github url (e.g. `https://github.com/my-organization/jupyterlab_pink_theme`).

## Project structure

Once you fill in the cookiecutter prompts, you'll get a basic theme extension. The files within are structured as follows:

* `python_name`

    * `style`: The assets (`.css` files, images, etc) that will make up your theme's actual style. This start out with the style from the default Jupyterlab light theme.

    * `src` - The extension source.

        * `index.ts`: Entry point for the JupyterLab extension

    * `package.json`: Metadata files that defines the files in your extension and their dependencies

    * `tsconfig.json`: Tells the TypeScript compiler how to build your extension

    * `setup.py`: The Python distribution file

## Package names

We suggest that extension names start with `jupyterlab_` and use underscores or dashes if needed to improve readability, such as `jupyterlab_myextension`.