JupyterLite Schema v0#

用于用户可维护的 JupyterLite 定制化的 schema

https://python.org/en/stable/reference/schema-v0.html#

JupyterLite 配置

JupyterLite 配置#

用于定制 JupyterLite 站点的用户可维护文件

属性

  • jupyter-lite-schema-version

实例遵循的 schema 版本

类型

整数

枚举

0

  • jupyter-config-data

Jupyter 配置数据

JupyterLab 设置覆盖#

按 @org/pkg:plugin 键入的配置对象映射，用于覆盖默认设置。请参阅 https://lab.jupyter.org.cn/en/stable/user/directories.html#overridesjson

类型

对象

patternProperties

  • ^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*:(.*)$

必须符合插件定义的 schema 的有效配置

类型

对象

Jupyter 配置数据#

PageConfig 读取的 jupyter-config-data <script> 的内容。这些已知值可以由其他扩展增强。

属性

  • appName

应用程序名称，会出现在“帮助”菜单中

类型

string

  • appVersion

应用程序的版本

类型

string

  • baseUrl

此 JupyterLite 的基本 URL，必须以 / 结尾，将由 config-utils.js 扩展以包含前导 /

类型

string

模式

.*/$

default

./

格式

uri

  • appUrl

要加载的默认应用程序

default

./lab

不以 / 结尾的 URI

  • defaultKernelName

默认内核的名称。如果不可用，将选择第一个内核（按字母顺序排列）。

类型

string

default

python

  • faviconUrl

要显示的浏览器标签图标

类型

string

default

./lab/favicon.ico

格式

uri

  • settingsOverrides

JupyterLab 设置覆盖

  • federated_extensions

类型

数组

default

项目

一个联邦扩展

  • fileTypes

用于服务和存储的 JupyterLab 兼容文件类型

additionalProperties

file-type

  • fullLabextensionsUrl

联邦扩展的路径，一个按 ({:org}/){package} 组织的文件夹

default

./extensions

不以 / 结尾的 URI

  • fullStaticUrl

到构建的静态资源的相对路径

default

./build

不以 / 结尾的 URI

  • enableMemoryStorage

启用内存存储回退，如果页面重新加载可能会丢失数据

类型

boolean

default

False

  • contentsStorageDrivers

用于内容的 localforage 驱动程序名称，或 null 表示最佳可用驱动程序

LocalForage 驱动程序集

  • contentsStorageName

用于在浏览器中存储 Jupyter 内容的名称。baseUrl 将附加到默认值

类型

string

default

JupyterLite 存储

  • showLoadingIndicator

应用程序初始化期间是否显示加载指示器

类型

boolean

default

False

  • settingsStorageDrivers

用于设置的 localforage 驱动程序名称，或 null 表示最佳可用驱动程序

LocalForage 驱动程序集

  • settingsStorageName

用于在浏览器中存储 Jupyter 设置的名称。baseUrl 将附加到默认值

类型

string

default

JupyterLite 存储

  • settingsUrl

到捆绑 schemas 的相对路径

default

./build/schemas

不以 / 结尾的 URI

  • themesUrl

到捆绑主题的相对路径

default

./build/themes

不以 / 结尾的 URI

  • licensesUrl

到捆绑许可证的相对路径

default

./lab/api/licenses

不以 / 结尾的 URI

  • disabledExtensions

要禁用的 Lab 扩展（或特定插件）

类型

数组

项目

oneOf

NPM 包名

JupyterLab 插件

  • litePluginSettings

JupyterLite 插件的附加配置选项，按 npm 兼容名称键入

类型

对象

additionalProperties

类型

对象

  • notebookPage

与命名 Notebook Classic UI 部分对应的页面

anyOf

未知笔记本页面

类型

string

已知笔记本页面

类型

string

枚举

consoles, notebooks, edit, tree

  • exposeAppInBrowser

是否将顶级 Application 实例作为 window.jupyterapp 可用

类型

boolean

default

False

  • enableServiceWorkerCache

是否启用服务工作缓存

类型

boolean

default

False

不以 / 结尾的 URI#

类型

string

模式

.*[^/]$

格式

uri

一个联邦扩展#

类型

对象

属性

  • extension

要加载的扩展模块的路径，相对于扩展的 package.json

类型

string

格式

uri

  • mimeExtension

要加载的 mime 扩展模块的路径，相对于扩展的 package.json

类型

string

格式

uri

  • load

到 WebPack 5 兼容的 remoteEntry*.js 文件的路径，描述了捆绑包

类型

string

格式

uri

  • name

NPM 包名

  • style

扩展提供的可选样式模块的路径

类型

string

格式

uri

file-type#

命名内容文件格式的描述，包括扩展名和 mime 类型。

类型

对象

属性

  • name

类型

string

  • mimeTypes

类型

数组

项目

类型

string

  • extensions

类型

数组

项目

类型

string

模式

^\..+

  • 文件格式

类型

string

枚举

base64, text, json

NPM 包名#

package.json 兼容的扩展名，带有可选的组织前缀。请参阅 dword-design/package-name-regex

类型

string

模式

^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*$

JupyterLab 插件#

package.json 兼容的扩展名，后跟冒号 (:) 和特定插件名

类型

string

模式

^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*:(.*)$

LocalForage 驱动程序集#

anyOf

detect

选择最佳可用驱动程序

类型

null

类型

数组

项目

LocalForage 驱动程序

LocalForage 驱动程序#

从任意数量的 localForage 驱动程序中选择一个存储驱动程序

anyOf

custom

使用第三方插件添加的自定义驱动程序

类型

string

IndexedDB

使用广泛兼容的 IndexedDB 键/值持久存储

类型

string

枚举

asyncStorage

WebSQL

使用 WebSQL 持久存储

类型

string

枚举

webSQLStorage

localStorage

使用 localStorage 持久存储

类型

string

枚举

localStorageWrapper

memory

使用基于内存的易失性存储：必须使用 enableMemoryStorage 启用

类型

string

枚举

memoryStorageDriver