jupyterlab / jupyterlab/plugin-playground

Allow additional plugin examples to be registered

Open
#50 4 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
60
Forks
21
PR merge metrics
No merged PRs in 30d

Description

### Problem

Some extensions are _themselves_ extensible (e.g. [jupyterlab-markup](https://github.com/agoose77/jupyterlab-markup), [jupyterlab-lsp](https://github.com/jupyter-lsp/jupyterlab-lsp)), and might like to advertise this in a more declarative way, especially in documentation/demo settings (e.g. #16).

### Proposed Solution

Offer a new launcher card per template.

Extend the public api proposed on #49 to allow registering new plugin templates, with a few options including a documentation markdown file.

### Additional context

#### Types

```ts
export interface IPluginExample {
title: string;
description: string;
src: () => Promise;
doc?: () => Promise;
icon?: LabIcon;
filename?: str;
}
export interface IPluginPlayground {
addExample(example: IPluginExample): void;
}
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.