forked from jupyterlite/jupyterlite
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jupyterlite.schema.v0.json
175 lines (175 loc) · 6.35 KB
/
jupyterlite.schema.v0.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://jupyterlite.readthedocs.org/en/latest/schema-v0.html#",
"title": "JupyterLite Schema v0",
"description": "a schema for user-serviceable customizaton of a JupyterLite",
"$ref": "#/definitions/top",
"definitions": {
"top": {
"title": "JupyterLite Configuration",
"description": "a user-serviceable file for customizing a JupyterLite site",
"properties": {
"jupyter-lite-schema-version": {
"type": "integer",
"description": "version of the schema to which the instance conforms",
"enum": [0]
},
"jupyter-config-data": {
"$ref": "#/definitions/jupyter-config-data"
}
}
},
"jupyterlab-settings-overrides": {
"title": "JupyterLab Settings Overrides",
"description": "A map of config objects keyed by `@org/pkg:plugin` which override the default settings. See https://jupyterlab.readthedocs.io/en/stable/user/directories.html#overridesjson",
"type": "object",
"patternProperties": {
"^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*:(.*)$": {
"description": "A valid configuration which must conform to the plugin's defined schema",
"type": "object"
}
}
},
"jupyter-config-data": {
"title": "Jupyter Config Data",
"description": "contents of a jupyter-config-data `<script>`, as read by `PageConfig`. These well-known values may be augmented by other extensions.",
"properties": {
"appName": {
"description": "The application name, as would appear in a Help menu",
"type": "string"
},
"appVersion": {
"description": "The version of the application",
"type": "string"
},
"baseUrl": {
"description": "base URL of this JupyterLite, must end in `/`, will be expanded by `config-utils.js` to include a leading `/`",
"type": "string",
"format": "uri",
"default": "./",
"pattern": ".*/$"
},
"appUrl": {
"description": "default app to load",
"default": "./lab",
"$ref": "#/definitions/non-trailing-slash-uri"
},
"faviconUrl": {
"description": "browser tab icon to show",
"type": "string",
"format": "uri",
"default": "./lab/favicon.ico"
},
"settingsOverrides": {
"$ref": "#/definitions/jupyterlab-settings-overrides"
},
"federated_extensions": {
"type": "array",
"items": {
"$ref": "#/definitions/federated-extension"
},
"default": []
},
"fullLabextensionsUrl": {
"description": "path to federated extensions, a folder organized by `({:org}/){package}`",
"default": "./lab/extensions",
"$ref": "#/definitions/non-trailing-slash-uri"
},
"fullMathjaxUrl": {
"type": "string",
"description": "path to MathJax2 assets",
"default": "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js",
"format": "uri"
},
"mathjaxConfig": {
"type": "string",
"default": "TeX-AMS_CHTML-full,Safe",
"description": "a valid MathJax configuration blob, a comma-delimted list of... something"
},
"fullStaticUrl": {
"description": "relative path to built static assets",
"default": "./lab/build",
"$ref": "#/definitions/non-trailing-slash-uri"
},
"settingsUrl": {
"description": "relative path to bundled schemas",
"default": "./lab/build/schemas",
"$ref": "#/definitions/non-trailing-slash-uri"
},
"themesUrl": {
"description": "relative path to bundled themes",
"default": "./lab/build/themes",
"$ref": "#/definitions/non-trailing-slash-uri"
},
"pyodideUrl": {
"description": "The path to the main pyodide.js entry point",
"type": "string",
"default": "https://cdn.jsdelivr.net/pyodide/v0.18.0/full/pyodide.js",
"format": "uri"
},
"disabledExtensions": {
"description": "Lab extensions (or specific plugins) to disable",
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/definitions/npm-package-name"
},
{
"$ref": "#/definitions/lab-extension-plugin-name"
}
]
}
}
}
},
"non-trailing-slash-uri": {
"title": "A URI what doesn't end in /",
"type": "string",
"format": "uri",
"pattern": ".*[^/]$"
},
"federated-extension": {
"title": "A Federated Extension",
"type": "object",
"required": ["name", "load"],
"properties": {
"extension": {
"type": "string",
"format": "uri",
"description": "path to the extension module to load, relative to the extension's `package.json`"
},
"mimeExtension": {
"type": "string",
"format": "uri",
"description": "path to the mime extension module to load, relative to the extension's `package.json`"
},
"load": {
"type": "string",
"format": "uri",
"description": "path to the WebPack 5-compatible `remoteEntry*.js` file describing the bundle"
},
"name": {
"$ref": "#/definitions/npm-package-name"
},
"style": {
"type": "string",
"format": "uri",
"description": "path to the optional style module provided by the extension"
}
}
},
"npm-package-name": {
"title": "An NPM Package Name",
"type": "string",
"description": "package.json-compatible extension name, with an optional organziation prefix. See https://github.com/dword-design/package-name-regex/blob/master/src/index.js",
"pattern": "^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*$"
},
"lab-extension-plugin-name": {
"title": "A JupyterLab Plugin",
"type": "string",
"description": "a package.json-compatible extension name followed by a colon (:) and a specific plugin name",
"pattern": "^(@[a-z0-9-~][a-z0-9-._~]*/)?[a-z0-9-~][a-z0-9-._~]*:(.*)$"
}
}
}