# mimerender-cookiecutter-ts

**Repository Path**: mirrors_jupyterlab/mimerender-cookiecutter-ts

## Basic Information

- **Project Name**: mimerender-cookiecutter-ts
- **Description**: Cookie cutter for JupyterLab mimerenderer extensions using TypeScript
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2025-10-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

**This project has been archived; for JupyterLab 4, please use [extension-template](https://github.com/jupyterlab/extension-template).**

# JupyterLab mimerender-cookiecutter-ts

![Github Actions Status](https://github.com/jupyterlab/mimerender-cookiecutter-ts/workflows/CI/badge.svg)

A [cookiecutter](https://github.com/cookiecutter/cookiecutter) template for creating
a JupyterLab MIME renderer extension in TypeScript.

## 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 MIME render extension.

```
cookiecutter https://github.com/jupyterlab/mimerender-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/mimerender-cookiecutter-ts --checkout v1.0
cookiecutter https://github.com/jupyterlab/mimerender-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.