@zpress/config 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$id": "https://raw.githubusercontent.com/joggrdocs/zpress/v0.4.0/packages/config/schemas/schema.json",
3
+ "$id": "https://raw.githubusercontent.com/joggrdocs/zpress/v0.5.0/packages/config/schemas/schema.json",
4
4
  "title": "Zpress Configuration",
5
5
  "description": "Configuration file for zpress documentation framework",
6
6
  "$ref": "#/definitions/ZpressConfig",
@@ -92,7 +92,7 @@
92
92
  "tagline": {
93
93
  "type": "string"
94
94
  },
95
- "workspaces": {
95
+ "apps": {
96
96
  "type": "array",
97
97
  "items": {
98
98
  "type": "object",
@@ -123,11 +123,69 @@
123
123
  }
124
124
  ]
125
125
  },
126
+ "icon": {
127
+ "anyOf": [
128
+ {
129
+ "$ref": "#/definitions/ZpressConfig/properties/icon"
130
+ },
131
+ {
132
+ "type": "object",
133
+ "properties": {
134
+ "id": {
135
+ "$ref": "#/definitions/ZpressConfig/properties/icon"
136
+ },
137
+ "color": {
138
+ "type": "string"
139
+ }
140
+ },
141
+ "required": [
142
+ "id",
143
+ "color"
144
+ ],
145
+ "additionalProperties": false
146
+ }
147
+ ]
148
+ },
126
149
  "description": {
127
150
  "type": "string"
128
151
  },
129
- "icon": {
130
- "$ref": "#/definitions/ZpressConfig/properties/icon"
152
+ "tags": {
153
+ "type": "array",
154
+ "items": {
155
+ "type": "string"
156
+ }
157
+ },
158
+ "badge": {
159
+ "type": "object",
160
+ "properties": {
161
+ "src": {
162
+ "type": "string"
163
+ },
164
+ "alt": {
165
+ "type": "string"
166
+ }
167
+ },
168
+ "required": [
169
+ "src",
170
+ "alt"
171
+ ],
172
+ "additionalProperties": false
173
+ },
174
+ "path": {
175
+ "type": "string"
176
+ },
177
+ "include": {
178
+ "anyOf": [
179
+ {
180
+ "type": "string"
181
+ },
182
+ {
183
+ "type": "array",
184
+ "items": {
185
+ "type": "string"
186
+ }
187
+ }
188
+ ]
131
189
  },
132
190
  "items": {
133
191
  "type": "array",
@@ -135,283 +193,142 @@
135
193
  "type": "object",
136
194
  "properties": {
137
195
  "title": {
138
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/title"
196
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/title"
139
197
  },
140
- "icon": {
198
+ "description": {
199
+ "type": "string"
200
+ },
201
+ "path": {
202
+ "type": "string"
203
+ },
204
+ "include": {
205
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/include"
206
+ },
207
+ "content": {
141
208
  "anyOf": [
142
209
  {
143
- "$ref": "#/definitions/ZpressConfig/properties/icon"
210
+ "type": "string"
144
211
  },
145
- {
146
- "type": "object",
147
- "properties": {
148
- "id": {
149
- "$ref": "#/definitions/ZpressConfig/properties/icon"
150
- },
151
- "color": {
152
- "type": "string"
153
- }
154
- },
155
- "required": [
156
- "id",
157
- "color"
158
- ],
159
- "additionalProperties": false
160
- }
212
+ {}
161
213
  ]
162
214
  },
163
- "description": {
164
- "type": "string"
215
+ "items": {
216
+ "type": "array",
217
+ "items": {
218
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/items/items"
219
+ }
220
+ },
221
+ "landing": {
222
+ "type": "boolean"
223
+ },
224
+ "collapsible": {
225
+ "type": "boolean"
165
226
  },
166
- "tags": {
227
+ "exclude": {
167
228
  "type": "array",
168
229
  "items": {
169
230
  "type": "string"
170
231
  }
171
232
  },
172
- "badge": {
233
+ "hidden": {
234
+ "type": "boolean"
235
+ },
236
+ "frontmatter": {
173
237
  "type": "object",
174
238
  "properties": {
175
- "src": {
239
+ "title": {
176
240
  "type": "string"
177
241
  },
178
- "alt": {
242
+ "titleTemplate": {
243
+ "type": [
244
+ "string",
245
+ "boolean"
246
+ ]
247
+ },
248
+ "description": {
179
249
  "type": "string"
180
- }
181
- },
182
- "required": [
183
- "src",
184
- "alt"
185
- ],
186
- "additionalProperties": false
187
- },
188
- "path": {
189
- "type": "string"
190
- },
191
- "include": {
192
- "anyOf": [
193
- {
250
+ },
251
+ "layout": {
194
252
  "type": "string"
195
253
  },
196
- {
197
- "type": "array",
198
- "items": {
199
- "type": "string"
200
- }
201
- }
202
- ]
203
- },
204
- "items": {
205
- "type": "array",
206
- "items": {
207
- "type": "object",
208
- "properties": {
209
- "title": {
210
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/title"
211
- },
212
- "description": {
213
- "type": "string"
214
- },
215
- "path": {
216
- "type": "string"
217
- },
218
- "include": {
219
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/include"
220
- },
221
- "content": {
222
- "anyOf": [
223
- {
224
- "type": "string"
225
- },
226
- {}
227
- ]
228
- },
229
- "items": {
230
- "type": "array",
231
- "items": {
232
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/items/items"
233
- }
234
- },
235
- "landing": {
236
- "type": "boolean"
237
- },
238
- "collapsible": {
239
- "type": "boolean"
240
- },
241
- "exclude": {
242
- "type": "array",
243
- "items": {
244
- "type": "string"
254
+ "sidebar": {
255
+ "type": "boolean"
256
+ },
257
+ "aside": {
258
+ "anyOf": [
259
+ {
260
+ "type": "boolean"
261
+ },
262
+ {
263
+ "type": "string",
264
+ "const": "left"
245
265
  }
246
- },
247
- "hidden": {
248
- "type": "boolean"
249
- },
250
- "frontmatter": {
251
- "type": "object",
252
- "properties": {
253
- "title": {
254
- "type": "string"
255
- },
256
- "titleTemplate": {
257
- "type": [
258
- "string",
259
- "boolean"
260
- ]
261
- },
262
- "description": {
263
- "type": "string"
264
- },
265
- "layout": {
266
- "type": "string"
267
- },
268
- "sidebar": {
269
- "type": "boolean"
270
- },
271
- "aside": {
272
- "anyOf": [
273
- {
274
- "type": "boolean"
275
- },
276
- {
277
- "type": "string",
278
- "const": "left"
279
- }
280
- ]
281
- },
282
- "outline": {
283
- "anyOf": [
284
- {
285
- "type": "boolean",
286
- "const": false
287
- },
288
- {
289
- "type": "number"
290
- },
291
- {
292
- "type": "array",
293
- "minItems": 2,
294
- "maxItems": 2,
295
- "items": [
296
- {
297
- "type": "number"
298
- },
299
- {
300
- "type": "number"
301
- }
302
- ]
303
- },
304
- {
305
- "type": "string",
306
- "const": "deep"
307
- }
308
- ]
309
- },
310
- "navbar": {
311
- "type": "boolean"
312
- },
313
- "editLink": {
314
- "type": "boolean"
315
- },
316
- "lastUpdated": {
317
- "type": "boolean"
318
- },
319
- "footer": {
320
- "type": "boolean"
321
- },
322
- "pageClass": {
323
- "type": "string"
324
- },
325
- "head": {
326
- "type": "array",
327
- "items": {
328
- "type": "array",
329
- "minItems": 2,
330
- "maxItems": 2,
331
- "items": [
332
- {
333
- "type": "string"
334
- },
335
- {
336
- "type": "object",
337
- "additionalProperties": {
338
- "type": "string"
339
- }
340
- }
341
- ]
266
+ ]
267
+ },
268
+ "outline": {
269
+ "anyOf": [
270
+ {
271
+ "type": "boolean",
272
+ "const": false
273
+ },
274
+ {
275
+ "type": "number"
276
+ },
277
+ {
278
+ "type": "array",
279
+ "minItems": 2,
280
+ "maxItems": 2,
281
+ "items": [
282
+ {
283
+ "type": "number"
284
+ },
285
+ {
286
+ "type": "number"
342
287
  }
343
- }
288
+ ]
344
289
  },
345
- "additionalProperties": true
346
- },
347
- "sort": {
348
- "anyOf": [
290
+ {
291
+ "type": "string",
292
+ "const": "deep"
293
+ }
294
+ ]
295
+ },
296
+ "navbar": {
297
+ "type": "boolean"
298
+ },
299
+ "editLink": {
300
+ "type": "boolean"
301
+ },
302
+ "lastUpdated": {
303
+ "type": "boolean"
304
+ },
305
+ "footer": {
306
+ "type": "boolean"
307
+ },
308
+ "pageClass": {
309
+ "type": "string"
310
+ },
311
+ "head": {
312
+ "type": "array",
313
+ "items": {
314
+ "type": "array",
315
+ "minItems": 2,
316
+ "maxItems": 2,
317
+ "items": [
349
318
  {
350
- "type": "string",
351
- "enum": [
352
- "default",
353
- "alpha",
354
- "filename"
355
- ]
356
- },
357
- {}
358
- ]
359
- },
360
- "recursive": {
361
- "type": "boolean"
362
- },
363
- "entryFile": {
364
- "type": "string"
365
- },
366
- "icon": {
367
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/icon"
368
- },
369
- "card": {
370
- "type": "object",
371
- "properties": {
372
- "icon": {
373
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/icon"
374
- },
375
- "scope": {
376
319
  "type": "string"
377
320
  },
378
- "description": {
379
- "type": "string"
380
- },
381
- "tags": {
382
- "type": "array",
383
- "items": {
321
+ {
322
+ "type": "object",
323
+ "additionalProperties": {
384
324
  "type": "string"
385
325
  }
386
- },
387
- "badge": {
388
- "type": "object",
389
- "properties": {
390
- "src": {
391
- "type": "string"
392
- },
393
- "alt": {
394
- "type": "string"
395
- }
396
- },
397
- "required": [
398
- "src",
399
- "alt"
400
- ],
401
- "additionalProperties": false
402
326
  }
403
- },
404
- "additionalProperties": false
405
- },
406
- "standalone": {
407
- "type": "boolean"
327
+ ]
408
328
  }
409
- },
410
- "required": [
411
- "title"
412
- ],
413
- "additionalProperties": false
414
- }
329
+ }
330
+ },
331
+ "additionalProperties": true
415
332
  },
416
333
  "sort": {
417
334
  "anyOf": [
@@ -423,59 +340,154 @@
423
340
  "filename"
424
341
  ]
425
342
  },
426
- {
427
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/items/items/properties/sort/anyOf/1"
428
- }
343
+ {}
429
344
  ]
430
345
  },
431
- "exclude": {
432
- "type": "array",
433
- "items": {
434
- "type": "string"
435
- }
436
- },
437
346
  "recursive": {
438
347
  "type": "boolean"
439
348
  },
440
349
  "entryFile": {
441
350
  "type": "string"
442
351
  },
443
- "frontmatter": {
444
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/items/items/properties/frontmatter"
352
+ "icon": {
353
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/icon"
445
354
  },
446
- "openapi": {
355
+ "card": {
447
356
  "type": "object",
448
357
  "properties": {
449
- "spec": {
450
- "type": "string"
358
+ "icon": {
359
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/icon"
451
360
  },
452
- "path": {
361
+ "scope": {
453
362
  "type": "string"
454
363
  },
455
- "title": {
364
+ "description": {
456
365
  "type": "string"
457
366
  },
458
- "sidebarLayout": {
459
- "type": "string",
460
- "enum": [
461
- "method-path",
462
- "title"
463
- ]
367
+ "tags": {
368
+ "type": "array",
369
+ "items": {
370
+ "type": "string"
371
+ }
372
+ },
373
+ "badge": {
374
+ "type": "object",
375
+ "properties": {
376
+ "src": {
377
+ "type": "string"
378
+ },
379
+ "alt": {
380
+ "type": "string"
381
+ }
382
+ },
383
+ "required": [
384
+ "src",
385
+ "alt"
386
+ ],
387
+ "additionalProperties": false
464
388
  }
465
389
  },
466
- "required": [
467
- "spec",
468
- "path"
469
- ],
470
390
  "additionalProperties": false
391
+ },
392
+ "standalone": {
393
+ "type": "boolean"
471
394
  }
472
395
  },
473
396
  "required": [
474
- "title",
475
- "description",
476
- "path"
397
+ "title"
477
398
  ],
478
399
  "additionalProperties": false
400
+ }
401
+ },
402
+ "sort": {
403
+ "anyOf": [
404
+ {
405
+ "type": "string",
406
+ "enum": [
407
+ "default",
408
+ "alpha",
409
+ "filename"
410
+ ]
411
+ },
412
+ {
413
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/items/items/properties/sort/anyOf/1"
414
+ }
415
+ ]
416
+ },
417
+ "exclude": {
418
+ "type": "array",
419
+ "items": {
420
+ "type": "string"
421
+ }
422
+ },
423
+ "recursive": {
424
+ "type": "boolean"
425
+ },
426
+ "entryFile": {
427
+ "type": "string"
428
+ },
429
+ "frontmatter": {
430
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/items/items/properties/frontmatter"
431
+ },
432
+ "openapi": {
433
+ "type": "object",
434
+ "properties": {
435
+ "spec": {
436
+ "type": "string"
437
+ },
438
+ "path": {
439
+ "type": "string"
440
+ },
441
+ "title": {
442
+ "type": "string"
443
+ },
444
+ "sidebarLayout": {
445
+ "type": "string",
446
+ "enum": [
447
+ "method-path",
448
+ "title"
449
+ ]
450
+ }
451
+ },
452
+ "required": [
453
+ "spec",
454
+ "path"
455
+ ],
456
+ "additionalProperties": false
457
+ }
458
+ },
459
+ "required": [
460
+ "title",
461
+ "description",
462
+ "path"
463
+ ],
464
+ "additionalProperties": false
465
+ }
466
+ },
467
+ "packages": {
468
+ "type": "array",
469
+ "items": {
470
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items"
471
+ }
472
+ },
473
+ "workspaces": {
474
+ "type": "array",
475
+ "items": {
476
+ "type": "object",
477
+ "properties": {
478
+ "title": {
479
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/title"
480
+ },
481
+ "description": {
482
+ "type": "string"
483
+ },
484
+ "icon": {
485
+ "$ref": "#/definitions/ZpressConfig/properties/icon"
486
+ },
487
+ "items": {
488
+ "type": "array",
489
+ "items": {
490
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items"
479
491
  },
480
492
  "minItems": 1
481
493
  },
@@ -497,7 +509,7 @@
497
509
  "type": "object",
498
510
  "properties": {
499
511
  "title": {
500
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/title"
512
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/title"
501
513
  },
502
514
  "description": {
503
515
  "type": "string"
@@ -506,7 +518,7 @@
506
518
  "type": "string"
507
519
  },
508
520
  "icon": {
509
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/icon"
521
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/icon"
510
522
  }
511
523
  },
512
524
  "required": [
@@ -558,7 +570,7 @@
558
570
  "type": "string"
559
571
  },
560
572
  "icon": {
561
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/icon"
573
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/icon"
562
574
  },
563
575
  "style": {
564
576
  "type": "string",
@@ -596,7 +608,7 @@
596
608
  "sections": {
597
609
  "type": "array",
598
610
  "items": {
599
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/items/items"
611
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/items/items"
600
612
  },
601
613
  "minItems": 1
602
614
  },
@@ -761,7 +773,7 @@
761
773
  "additionalProperties": false
762
774
  },
763
775
  "openapi": {
764
- "$ref": "#/definitions/ZpressConfig/properties/workspaces/items/properties/items/items/properties/openapi"
776
+ "$ref": "#/definitions/ZpressConfig/properties/apps/items/properties/openapi"
765
777
  }
766
778
  },
767
779
  "required": [