JupyterLite 模式 v0

用于 JupyterLite 用户可服务自定义的模式

https://jupyterlite.readthedocs.org/en/latest/reference/schema-v0.html#

JupyterLite 配置

JupyterLite 配置

用于自定义 JupyterLite 站点的用户可服务文件

属性
jupyter-lite-schema-version	实例符合的模式版本
	类型	整数
	枚举	0
jupyter-config-data	Jupyter 配置数据

JupyterLab 设置覆盖

一个由 @org/pkg:plugin 作为键的配置对象映射，覆盖默认设置。参见 https://jupyterlab.pythonlang.cn/en/stable/user/directories.html#overridesjson

类型	对象
patternProperties
^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*:(.*)$	必须符合插件定义的模式的有效配置
	类型	对象

Jupyter 配置数据

jupyter-config-data <script> 的内容，由 PageConfig 读取。这些众所周知的 value 可能被其他扩展增强。

属性
appName	应用程序名称，如在帮助菜单中显示
	类型	字符串
appVersion	应用程序的版本
	类型	字符串
baseUrl	此 JupyterLite 的基本 URL，必须以 / 结尾，将由 config-utils.js 扩展以包含前导 /
	类型	字符串
	模式	.*/$
	默认	./
	格式	uri
appUrl	要加载的默认应用程序
	默认	./lab
	不以 / 结尾的 URI
defaultKernelName	默认内核的名称。如果不可用，将选择第一个内核（按字母顺序）。
	类型	字符串
	默认	python
faviconUrl	要显示的浏览器选项卡图标
	类型	字符串
	默认	./lab/favicon.ico
	格式	uri
settingsOverrides	JupyterLab 设置覆盖
federated_extensions	类型	数组
	默认
	项目	联合扩展
fileTypes	用于服务和存储的兼容 JupyterLab 的文件类型
	additionalProperties	文件类型
fullLabextensionsUrl	联合扩展的路径，一个按 ({:org}/){package} 组织的文件夹
	默认	./extensions
	不以 / 结尾的 URI
fullWebRtcSignalingUrls	用于查找 WebRTC 对等点的 WebSocket URL。需要 jupyterlab-webrtc-docprovider。
	类型	数组
	默认	wss://signaling.yjs.dev
		wss://y-webrtc-signaling-eu.herokuapp.com
		wss://y-webrtc-signaling-us.herokuapp.com
	项目	类型	字符串
		格式	uri
	minItems	1
fullStaticUrl	构建的静态资产的相对路径
	默认	./build
	不以 / 结尾的 URI
enableMemoryStorage	启用内存存储回退，如果页面重新加载，可能会丢失数据
	类型	布尔值
	默认	False
contentsStorageDrivers	内容的 localforage 驱动程序名称，或 null 表示最佳可用驱动程序
	一个 LocalForage 驱动程序集
contentsStorageName	用于在浏览器中存储 Jupyter 内容的名称
	类型	字符串
	默认	JupyterLite 存储
settingsStorageDrivers	设置的 localforage 驱动程序名称，或 null 表示最佳可用驱动程序
	一个 LocalForage 驱动程序集
settingsStorageName	用于在浏览器中存储 Jupyter 设置的名称
	类型	字符串
	默认	JupyterLite 存储
settingsUrl	捆绑的模式的相对路径
	默认	./build/schemas
	不以 / 结尾的 URI
themesUrl	捆绑的主题的相对路径
	默认	./build/themes
	不以 / 结尾的 URI
licensesUrl	捆绑的许可证的相对路径
	默认	./lab/api/licenses
	不以 / 结尾的 URI
disabledExtensions	要禁用的 Lab 扩展（或特定插件）
	类型	数组
	项目	oneOf	一个 NPM 包名称
			一个 JupyterLab 插件
litePluginSettings	jupyterlite 插件的附加配置选项，按 npm 兼容名称键控
	类型	对象
	additionalProperties	类型	对象
notebookPage	对应于命名 Notebook Classic UI 部分的页面
	anyOf	一个未知的笔记本页面
		类型	字符串
		一个众所周知的笔记本页面
		类型	字符串
		枚举	consoles, notebooks, edit, tree
exposeAppInBrowser	是否将顶级 Application 实例作为 window.jupyterapp 提供
	类型	布尔值
	默认	False
协作	是否启用通过 WebRTC 的协作编辑。应与 ?room=<room name> URL 参数配对
	类型	布尔值
	默认	False
enableServiceWorkerCache	是否启用服务工作者缓存
	类型	布尔值
	默认	False

不以 / 结尾的 URI

类型	字符串
模式	.*[^/]$
格式	uri

联合扩展

类型	对象
属性
扩展	要加载的扩展模块的路径，相对于扩展的 package.json
	类型	字符串
	格式	uri
mimeExtension	要加载的 mime 扩展模块的路径，相对于扩展的 package.json
	类型	字符串
	格式	uri
加载	描述捆绑包的 WebPack 5 兼容 remoteEntry*.js 文件的路径
	类型	字符串
	格式	uri
名称	一个 NPM 包名称
样式	扩展提供的可选样式模块的路径
	类型	字符串
	格式	uri

文件类型

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

类型	对象
属性
名称	类型	字符串
mimeTypes	类型	数组
	项目	类型	字符串
扩展名	类型	数组
	项目	类型	字符串
		模式	^\..+
文件格式	类型	字符串
	枚举	base64, text, json

NPM 包名称

与 package.json 兼容的扩展名，可以选择添加组织前缀。参见 dword-design/package-name-regex

类型	字符串
模式	^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*$

JupyterLab 插件

与 package.json 兼容的扩展名，后面跟着冒号 (:) 和一个特定的插件名称

类型	字符串
模式	^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*:(.*)$

LocalForage 驱动程序集

anyOf	检测
	选择最佳可用驱动程序
	类型	空
	类型	数组
	项目	LocalForage 驱动程序

LocalForage 驱动程序

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

anyOf	自定义
	使用第三方插件添加的自定义驱动程序
	类型	字符串
	IndexedDB
	使用广泛兼容的 IndexedDB 键值持久存储
	类型	字符串
	枚举	asyncStorage
	WebSQL
	使用 WebSQL 持久存储
	类型	字符串
	枚举	webSQLStorage
	localStorage
	使用 localStorage 持久存储
	类型	字符串
	枚举	localStorageWrapper
	内存
	使用基于内存的易失性存储：必须使用 enableMemoryStorage 启用
	类型	字符串
	枚举	localStorageWrapper