Skip to content

Commit 5623594

Browse files
committed
notebooks: mention tags used for notebook discovery
Fixes microsoft/vscode#123581
1 parent 33dd3e4 commit 5623594

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

api/extension-guides/notebook.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,8 @@ class Controller {
172172
}
173173
```
174174

175+
If you're publishing a `NotebookController`-providing extension separately from its serializer, then add an entry like `notebookKernel<ViewTypeUpperCamelCased>` to the `keywords` in its `package.json`. For example, if you published an alternative kernel for the `github-issues` notebook type, you should add a keyword `notebookKernelGithubIssues` keyword to your extension.
176+
175177
Samples:
176178

177179
* [GitHub Issues Notebook](https://github.com/microsoft/vscode-github-issue-notebooks/blob/93359d842cd01dfaef0a78b620c5a3b4cf5c2e38/src/extension/notebookProvider.ts#L29): Controller to execute queries for GitHub Issues
@@ -265,6 +267,8 @@ npm install -g yo generator-code
265267

266268
Then, run `yo code` and choose `New Notebook Renderer (TypeScript)`.
267269

270+
If you don't use this template, you'll just want to make sure that you add `notebookRenderer` to the `keywords` in your extension's `package.json`, and mention its mimetype somewhere in the extension name or description, so that users can find your renderer.
271+
268272
### A Simple, Non-Interactive Renderer
269273

270274
Renderers are declared for a set of mimetypes by contributing to the `contributes.notebookRenderer` property of an extension's `package.json`. This renderer will work with input in the `ms-vscode.github-issue-notebook/github-issue` format, which we will assume some installed controller is able to provide:

0 commit comments

Comments
 (0)