jupyterlab/mimerender-cookiecutter-ts

Name: mimerender-cookiecutter-ts

Owner: JupyterLab

Description: Cookie cutter for JupyterLab mimerenderer extensions using TypeScript

Created: 2017-08-23 02:55:11.0

Updated: 2017-08-23 15:36:07.0

Pushed: 2018-02-09 11:51:59.0

Homepage: null

Size: 10

Language: TypeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

JupyterLab mimerender-cookiecutter-ts

A cookiecutter template for creating a JupyterLab MIME renderer extension in TypeScript. (See also mimerender-cookiecutter-js for a MIME renderer extension in CommonJS.)

Use the template to create package

Install cookiecutter.

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.

iecutter https://github.com/jupyterlab/mimerender-cookiecutter-ts

A simple example

The src/ directory of your new extension includes a very simple example of a working extension, written in TypeScript. Use this example as a guide to build your own extension.

Package name

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