notebooks: mention tags used for notebook discovery

Fixes https://github.com/microsoft/vscode/issues/123581
This commit is contained in:
Connor Peet 2021-09-20 15:17:14 -07:00
Родитель 33dd3e4b93
Коммит 5623594fb4
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: CF8FD2EA0DBC61BD
1 изменённых файлов: 4 добавлений и 0 удалений

Просмотреть файл

@ -172,6 +172,8 @@ class Controller {
}
```
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.
Samples:
* [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
Then, run `yo code` and choose `New Notebook Renderer (TypeScript)`.
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.
### A Simple, Non-Interactive Renderer
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: