blodemd 0.0.7 → 0.0.9

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.
Files changed (61) hide show
  1. package/README.md +25 -9
  2. package/dev-server/app/[[...slug]]/page.tsx +1 -0
  3. package/dev-server/next.config.js +11 -13
  4. package/dev-server/package.json +1 -1
  5. package/dev-server/tsconfig.json +3 -0
  6. package/dist/cli.mjs +869 -184
  7. package/dist/cli.mjs.map +1 -1
  8. package/docs/components/api/api-playground.tsx +255 -80
  9. package/docs/components/api/api-reference.tsx +11 -1
  10. package/docs/components/docs/contextual-menu.tsx +227 -142
  11. package/docs/components/docs/copy-page-menu.tsx +132 -85
  12. package/docs/components/docs/doc-header.tsx +13 -3
  13. package/docs/components/docs/doc-shell.tsx +22 -11
  14. package/docs/components/docs/mobile-nav.tsx +0 -6
  15. package/docs/components/mdx/code-group.tsx +171 -62
  16. package/docs/components/mdx/tabs.tsx +131 -26
  17. package/docs/components/ui/input.tsx +0 -1
  18. package/docs/components/ui/search.tsx +241 -132
  19. package/docs/lib/content-root.ts +33 -0
  20. package/docs/lib/content-source.ts +70 -0
  21. package/docs/lib/contextual-options.ts +20 -0
  22. package/docs/lib/docs-runtime.tsx +595 -0
  23. package/docs/lib/edge-config.ts +95 -0
  24. package/docs/lib/env.ts +22 -0
  25. package/docs/lib/openapi-proxy.ts +88 -0
  26. package/docs/lib/platform-config.ts +6 -0
  27. package/docs/lib/routes.ts +39 -0
  28. package/docs/lib/supabase.ts +13 -0
  29. package/docs/lib/tenancy.ts +322 -0
  30. package/docs/lib/tenant-headers.ts +14 -0
  31. package/docs/lib/tenant-static.ts +529 -0
  32. package/docs/lib/tenant-utility-context.ts +62 -0
  33. package/docs/lib/tenants.ts +68 -0
  34. package/docs/lib/use-mobile.ts +19 -0
  35. package/package.json +3 -2
  36. package/packages/@repo/common/dist/index.d.ts +7 -0
  37. package/packages/@repo/common/dist/index.d.ts.map +1 -1
  38. package/packages/@repo/common/dist/index.js +42 -0
  39. package/packages/@repo/common/src/index.ts +50 -0
  40. package/packages/@repo/contracts/dist/project.d.ts +1 -1
  41. package/packages/@repo/contracts/dist/project.js +1 -1
  42. package/packages/@repo/contracts/src/project.ts +1 -1
  43. package/packages/@repo/models/dist/docs-config.d.ts +194 -29
  44. package/packages/@repo/models/dist/docs-config.d.ts.map +1 -1
  45. package/packages/@repo/models/dist/docs-config.js +3 -28
  46. package/packages/@repo/models/src/docs-config.ts +5 -31
  47. package/packages/@repo/previewing/dist/blob-source.d.ts.map +1 -1
  48. package/packages/@repo/previewing/dist/blob-source.js +7 -2
  49. package/packages/@repo/previewing/dist/fs-source.d.ts.map +1 -1
  50. package/packages/@repo/previewing/dist/fs-source.js +2 -3
  51. package/packages/@repo/previewing/dist/index.d.ts.map +1 -1
  52. package/packages/@repo/previewing/dist/index.js +1 -41
  53. package/packages/@repo/previewing/src/blob-source.ts +7 -4
  54. package/packages/@repo/previewing/src/fs-source.ts +2 -3
  55. package/packages/@repo/previewing/src/index.ts +3 -55
  56. package/packages/@repo/validation/dist/index.d.ts +2 -2
  57. package/packages/@repo/validation/dist/index.d.ts.map +1 -1
  58. package/packages/@repo/validation/dist/index.js +2 -2
  59. package/packages/@repo/validation/package.json +1 -0
  60. package/packages/@repo/validation/src/{mintlify-docs-schema.json → blodemd-docs-schema.json} +346 -1794
  61. package/packages/@repo/validation/src/index.ts +4 -4
package/packages/@repo/validation/src/{mintlify-docs-schema.json → blodemd-docs-schema.json} RENAMED
@@ -1,1797 +1,7 @@
1
1
  {
2
- "anyOf": [
3
- {
4
- "type": "object",
5
- "properties": {
6
- "theme": {
7
- "type": "string",
8
- "const": "mint"
9
- },
10
- "$schema": {
11
- "type": "string",
12
- "format": "uri",
13
- "default": "https://docs.blode.md/docs.json",
14
- "description": "The URL of the schema file"
15
- },
16
- "name": {
17
- "type": "string",
18
- "minLength": 1,
19
- "description": "The name of the project, organization, or product"
20
- },
21
- "public": {
22
- "type": "boolean",
23
- "description": "Whether the documentation is publicly accessible by default"
24
- },
25
- "description": {
26
- "type": "string",
27
- "description": "Optional description used for SEO and LLM indexing"
28
- },
29
- "colors": {
30
- "$ref": "#/definitions/colorsSchema"
31
- },
32
- "logo": {
33
- "anyOf": [
34
- {
35
- "type": "string",
36
- "minLength": 3,
37
- "description": "The logo (for both light and dark mode)"
38
- },
39
- {
40
- "type": "object",
41
- "properties": {
42
- "light": {
43
- "type": "string",
44
- "description": "Path pointing to the light logo file to use in dark mode, including the file extension. Example: `/logo.png`"
45
- },
46
- "dark": {
47
- "type": "string",
48
- "description": "Path pointing to the dark logo file to use in light mode, including the file extension. Example: `/logo-dark.png`"
49
- },
50
- "href": {
51
- "$ref": "#/definitions/anchorSchema/anyOf/0/properties/href",
52
- "description": "The URL to redirect to when clicking the logo. If not provided, the logo will link to the homepage. Example: `https://example.com`"
53
- }
54
- },
55
- "required": ["light", "dark"],
56
- "additionalProperties": false
57
- }
58
- ],
59
- "description": "The logo configuration. Can be a single image path for both light and dark mode, or separate paths for each mode with an optional click target URL"
60
- },
61
- "favicon": {
62
- "anyOf": [
63
- {
64
- "type": "string",
65
- "description": "Path pointing to the favicon file in your docs folder, including the file extension. The favicon will automatically be resized to the appropriate sizes"
66
- },
67
- {
68
- "type": "object",
69
- "properties": {
70
- "light": {
71
- "type": "string",
72
- "description": "Path pointing to the light favicon file to use in dark mode, including the file extension. Example: `/favicon.png`"
73
- },
74
- "dark": {
75
- "type": "string",
76
- "description": "Path pointing to the dark favicon file to use in light mode, including the file extension. Example: `/favicon-dark.png`"
77
- }
78
- },
79
- "required": ["light", "dark"],
80
- "additionalProperties": false,
81
- "description": "The path to the favicon. Can be a single file or a pair for light and dark mode. Example: `/favicon.png`"
82
- }
83
- ]
84
- },
85
- "api": {
86
- "type": "object",
87
- "properties": {
88
- "openapi": {
89
- "$ref": "#/definitions/anchorSchema/anyOf/0/properties/openapi",
90
- "description": "A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s)"
91
- },
92
- "asyncapi": {
93
- "$ref": "#/definitions/anchorSchema/anyOf/0/properties/asyncapi",
94
- "description": "A string or an array of strings of absolute or relative urls pointing to the AsyncAPI file(s)"
95
- },
96
- "params": {
97
- "type": "object",
98
- "properties": {
99
- "expanded": {
100
- "type": "string",
101
- "enum": ["all", "closed"],
102
- "description": "The view mode of the API parameters. Defaults to `closed`."
103
- }
104
- },
105
- "additionalProperties": false,
106
- "description": "Configurations for the API parameters"
107
- },
108
- "playground": {
109
- "type": "object",
110
- "properties": {
111
- "display": {
112
- "type": "string",
113
- "enum": ["interactive", "simple", "none", "auth"],
114
- "description": "The display mode of the API playground. Defaults to `interactive`. Use `auth` to show the playground only to authenticated users."
115
- },
116
- "proxy": {
117
- "type": "boolean",
118
- "description": "Whether to pass API requests through a proxy server. Defaults to `true`."
119
- },
120
- "credentials": {
121
- "type": "boolean",
122
- "description": "Whether to include cookies/auth for cross-origin requests when proxy is disabled. Defaults to `false`."
123
- }
124
- },
125
- "additionalProperties": false,
126
- "description": "Configurations for the API playground"
127
- },
128
- "examples": {
129
- "type": "object",
130
- "properties": {
131
- "defaults": {
132
- "type": "string",
133
- "enum": ["required", "all"],
134
- "description": "Whether to show only required parameters in the examples, defaults to `all`."
135
- },
136
- "languages": {
137
- "type": "array",
138
- "items": {
139
- "type": "string"
140
- },
141
- "description": "Example languages for the autogenerated API snippets"
142
- },
143
- "prefill": {
144
- "type": "boolean",
145
- "description": "Whether to prefill the API playground with the examples"
146
- },
147
- "autogenerate": {
148
- "type": "boolean",
149
- "description": "Whether to generate code samples for API endpoints. Defaults to `true`. If `false`, only manually-written code samples (from either `x-codeSamples` property in the OpenAPI spec or `<RequestExample>` components in the MDX files) will be shown."
150
- }
151
- },
152
- "additionalProperties": false,
153
- "description": "Configurations for the autogenerated API examples"
154
- },
155
- "url": {
156
- "type": "string",
157
- "enum": ["full"],
158
- "description": "The display mode of the base URL in the endpoint header. Set to `full` to always show the full base URL on every endpoint page."
159
- },
160
- "mdx": {
161
- "type": "object",
162
- "properties": {
163
- "auth": {
164
- "type": "object",
165
- "properties": {
166
- "method": {
167
- "type": "string",
168
- "enum": ["bearer", "basic", "key", "cobo"],
169
- "description": "Authentication method for the API"
170
- },
171
- "name": {
172
- "type": "string",
173
- "description": "Authentication name for the API"
174
- }
175
- },
176
- "additionalProperties": false,
177
- "description": "Authentication configuration for the API"
178
- },
179
- "server": {
180
- "anyOf": [
181
- {
182
- "type": "string",
183
- "format": "uri"
184
- },
185
- {
186
- "type": "array",
187
- "items": {
188
- "type": "string",
189
- "format": "uri"
190
- }
191
- }
192
- ],
193
- "description": "Base URL(s) for the API"
194
- }
195
- },
196
- "additionalProperties": false,
197
- "description": "Configurations for API pages generated from MDX files"
198
- }
199
- },
200
- "additionalProperties": false,
201
- "description": "API reference configuration and playground settings"
202
- },
203
- "appearance": {
204
- "type": "object",
205
- "properties": {
206
- "default": {
207
- "type": "string",
208
- "enum": ["system", "light", "dark"],
209
- "description": "The default light/dark mode. Defaults to system"
210
- },
211
- "strict": {
212
- "type": "boolean",
213
- "description": "Whether to hide the light / dark mode toggle. Defaults to `false`."
214
- }
215
- },
216
- "additionalProperties": false,
217
- "description": "Light / dark mode toggle settings"
218
- },
219
- "background": {
220
- "type": "object",
221
- "properties": {
222
- "image": {
223
- "anyOf": [
224
- {
225
- "type": "string"
226
- },
227
- {
228
- "type": "object",
229
- "properties": {
230
- "light": {
231
- "type": "string"
232
- },
233
- "dark": {
234
- "type": "string"
235
- }
236
- },
237
- "required": ["light", "dark"],
238
- "additionalProperties": false
239
- }
240
- ],
241
- "description": "A fixed background image. Can be an absolute URL or relative path."
242
- },
243
- "decoration": {
244
- "type": "string",
245
- "enum": ["gradient", "grid", "windows"],
246
- "description": "The background decoration of the theme"
247
- },
248
- "color": {
249
- "$ref": "#/definitions/anchorSchema/anyOf/0/properties/color",
250
- "description": "The colors of the background"
251
- }
252
- },
253
- "additionalProperties": false,
254
- "description": "Background color and decoration settings"
255
- },
256
- "navbar": {
257
- "$ref": "#/definitions/anchorSchema/anyOf/0/properties/global/properties/languages/items/properties/navbar",
258
- "description": "Navbar content and settings"
259
- },
260
- "navigation": {
261
- "$ref": "#/definitions/navigationSchema"
262
- },
263
- "footer": {
264
- "$ref": "#/definitions/anchorSchema/anyOf/0/properties/global/properties/languages/items/properties/footer",
265
- "description": "Footer configurations"
266
- },
267
- "search": {
268
- "type": "object",
269
- "properties": {
270
- "prompt": {
271
- "type": "string",
272
- "description": "The prompt to be displayed in the search bar placeholder"
273
- }
274
- },
275
- "additionalProperties": false,
276
- "description": "Search display settings"
277
- },
278
- "seo": {
279
- "type": "object",
280
- "properties": {
281
- "metatags": {
282
- "type": "object",
283
- "additionalProperties": {
284
- "type": "string",
285
- "minLength": 1
286
- },
287
- "description": "Meta tags added to every page. Must be a valid key-value pair"
288
- },
289
- "indexing": {
290
- "type": "string",
291
- "enum": ["navigable", "all"],
292
- "description": "Specify which pages to be indexed by search engines. Setting `navigable` indexes pages that are set in navigation, `all` indexes all pages. Defaults to `navigable`."
293
- }
294
- },
295
- "additionalProperties": false,
296
- "description": "SEO indexing configurations"
297
- },
298
- "fonts": {
299
- "anyOf": [
300
- {
301
- "type": "object",
302
- "properties": {
303
- "family": {
304
- "type": "string",
305
- "description": "The font family, such as \"Open Sans\", \"Playfair Display\""
306
- },
307
- "weight": {
308
- "type": "number",
309
- "description": "The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts."
310
- },
311
- "source": {
312
- "type": "string",
313
- "minLength": 1,
314
- "description": "The font source, such as /path/to/font.woff2 or https://example.com/path/to/font.woff2"
315
- },
316
- "format": {
317
- "type": "string",
318
- "enum": ["woff", "woff2"],
319
- "description": "The font format, can be one of woff, woff2"
320
- }
321
- },
322
- "required": ["family"],
323
- "additionalProperties": false
324
- },
325
- {
326
- "type": "object",
327
- "properties": {
328
- "heading": {
329
- "$ref": "#/anyOf/0/properties/fonts/anyOf/0"
330
- },
331
- "body": {
332
- "$ref": "#/anyOf/0/properties/fonts/anyOf/0"
333
- }
334
- },
335
- "additionalProperties": false
336
- }
337
- ],
338
- "description": "The fonts to be used"
339
- },
340
- "icons": {
341
- "type": "object",
342
- "properties": {
343
- "library": {
344
- "type": "string",
345
- "enum": ["fontawesome", "lucide", "tabler"],
346
- "description": "The icon library to be used. Defaults to `fontawesome`."
347
- }
348
- },
349
- "required": ["library"],
350
- "additionalProperties": false,
351
- "description": "Icon library settings"
352
- },
353
- "styling": {
354
- "type": "object",
355
- "properties": {
356
- "eyebrows": {
357
- "type": "string",
358
- "enum": ["section", "breadcrumbs"],
359
- "description": "The eyebrows style of the content. Defaults to `section`."
360
- },
361
- "codeblocks": {
362
- "anyOf": [
363
- {
364
- "anyOf": [
365
- {
366
- "not": {}
367
- },
368
- {
369
- "type": "string",
370
- "enum": ["system", "dark"]
371
- }
372
- ]
373
- },
374
- {
375
- "type": "object",
376
- "properties": {
377
- "theme": {
378
- "anyOf": [
379
- {
380
- "type": "string",
381
- "enum": [
382
- "andromeeda",
383
- "aurora-x",
384
- "ayu-dark",
385
- "catppuccin-frappe",
386
- "catppuccin-latte",
387
- "catppuccin-macchiato",
388
- "catppuccin-mocha",
389
- "dark-plus",
390
- "dracula",
391
- "dracula-soft",
392
- "everforest-dark",
393
- "everforest-light",
394
- "github-dark",
395
- "github-dark-default",
396
- "github-dark-dimmed",
397
- "github-dark-high-contrast",
398
- "github-light",
399
- "github-light-default",
400
- "github-light-high-contrast",
401
- "gruvbox-dark-hard",
402
- "gruvbox-dark-medium",
403
- "gruvbox-dark-soft",
404
- "gruvbox-light-hard",
405
- "gruvbox-light-medium",
406
- "gruvbox-light-soft",
407
- "houston",
408
- "kanagawa-dragon",
409
- "kanagawa-lotus",
410
- "kanagawa-wave",
411
- "laserwave",
412
- "light-plus",
413
- "material-theme",
414
- "material-theme-darker",
415
- "material-theme-lighter",
416
- "material-theme-ocean",
417
- "material-theme-palenight",
418
- "min-dark",
419
- "min-light",
420
- "monokai",
421
- "night-owl",
422
- "nord",
423
- "one-dark-pro",
424
- "one-light",
425
- "plastic",
426
- "poimandres",
427
- "red",
428
- "rose-pine",
429
- "rose-pine-dawn",
430
- "rose-pine-moon",
431
- "slack-dark",
432
- "slack-ochin",
433
- "snazzy-light",
434
- "solarized-dark",
435
- "solarized-light",
436
- "synthwave-84",
437
- "tokyo-night",
438
- "vesper",
439
- "vitesse-black",
440
- "vitesse-dark",
441
- "vitesse-light",
442
- "css-variables"
443
- ]
444
- },
445
- {
446
- "type": "object",
447
- "properties": {
448
- "light": {
449
- "type": "string",
450
- "enum": [
451
- "andromeeda",
452
- "aurora-x",
453
- "ayu-dark",
454
- "catppuccin-frappe",
455
- "catppuccin-latte",
456
- "catppuccin-macchiato",
457
- "catppuccin-mocha",
458
- "dark-plus",
459
- "dracula",
460
- "dracula-soft",
461
- "everforest-dark",
462
- "everforest-light",
463
- "github-dark",
464
- "github-dark-default",
465
- "github-dark-dimmed",
466
- "github-dark-high-contrast",
467
- "github-light",
468
- "github-light-default",
469
- "github-light-high-contrast",
470
- "gruvbox-dark-hard",
471
- "gruvbox-dark-medium",
472
- "gruvbox-dark-soft",
473
- "gruvbox-light-hard",
474
- "gruvbox-light-medium",
475
- "gruvbox-light-soft",
476
- "houston",
477
- "kanagawa-dragon",
478
- "kanagawa-lotus",
479
- "kanagawa-wave",
480
- "laserwave",
481
- "light-plus",
482
- "material-theme",
483
- "material-theme-darker",
484
- "material-theme-lighter",
485
- "material-theme-ocean",
486
- "material-theme-palenight",
487
- "min-dark",
488
- "min-light",
489
- "monokai",
490
- "night-owl",
491
- "nord",
492
- "one-dark-pro",
493
- "one-light",
494
- "plastic",
495
- "poimandres",
496
- "red",
497
- "rose-pine",
498
- "rose-pine-dawn",
499
- "rose-pine-moon",
500
- "slack-dark",
501
- "slack-ochin",
502
- "snazzy-light",
503
- "solarized-dark",
504
- "solarized-light",
505
- "synthwave-84",
506
- "tokyo-night",
507
- "vesper",
508
- "vitesse-black",
509
- "vitesse-dark",
510
- "vitesse-light",
511
- "css-variables"
512
- ]
513
- },
514
- "dark": {
515
- "type": "string",
516
- "enum": [
517
- "andromeeda",
518
- "aurora-x",
519
- "ayu-dark",
520
- "catppuccin-frappe",
521
- "catppuccin-latte",
522
- "catppuccin-macchiato",
523
- "catppuccin-mocha",
524
- "dark-plus",
525
- "dracula",
526
- "dracula-soft",
527
- "everforest-dark",
528
- "everforest-light",
529
- "github-dark",
530
- "github-dark-default",
531
- "github-dark-dimmed",
532
- "github-dark-high-contrast",
533
- "github-light",
534
- "github-light-default",
535
- "github-light-high-contrast",
536
- "gruvbox-dark-hard",
537
- "gruvbox-dark-medium",
538
- "gruvbox-dark-soft",
539
- "gruvbox-light-hard",
540
- "gruvbox-light-medium",
541
- "gruvbox-light-soft",
542
- "houston",
543
- "kanagawa-dragon",
544
- "kanagawa-lotus",
545
- "kanagawa-wave",
546
- "laserwave",
547
- "light-plus",
548
- "material-theme",
549
- "material-theme-darker",
550
- "material-theme-lighter",
551
- "material-theme-ocean",
552
- "material-theme-palenight",
553
- "min-dark",
554
- "min-light",
555
- "monokai",
556
- "night-owl",
557
- "nord",
558
- "one-dark-pro",
559
- "one-light",
560
- "plastic",
561
- "poimandres",
562
- "red",
563
- "rose-pine",
564
- "rose-pine-dawn",
565
- "rose-pine-moon",
566
- "slack-dark",
567
- "slack-ochin",
568
- "snazzy-light",
569
- "solarized-dark",
570
- "solarized-light",
571
- "synthwave-84",
572
- "tokyo-night",
573
- "vesper",
574
- "vitesse-black",
575
- "vitesse-dark",
576
- "vitesse-light",
577
- "css-variables"
578
- ]
579
- }
580
- },
581
- "required": ["light", "dark"],
582
- "additionalProperties": false
583
- }
584
- ]
585
- },
586
- "languages": {
587
- "type": "object",
588
- "properties": {
589
- "custom": {
590
- "type": "array",
591
- "items": {
592
- "type": "string",
593
- "description": "Path (absolute or relative) to a JSON file describing a custom Shiki language"
594
- }
595
- }
596
- },
597
- "additionalProperties": false,
598
- "description": "Custom language configuration for codeblocks"
599
- }
600
- },
601
- "additionalProperties": false
602
- }
603
- ],
604
- "description": "The codeblock theme configuration. Defaults to `system`. To use a built-in shiki theme, add the theme name as \"theme\" in the object. To use different shiki themes for light and dark modes, add \"themes\" in the object with \"dark\" and \"light\" keys."
605
- },
606
- "latex": {
607
- "type": "boolean",
608
- "description": "Whether to include latex styling, overriding our default latex detection"
609
- }
610
- },
611
- "additionalProperties": false,
612
- "description": "Styling configurations"
613
- },
614
- "redirects": {
615
- "type": "array",
616
- "items": {
617
- "type": "object",
618
- "properties": {
619
- "source": {
620
- "type": "string"
621
- },
622
- "destination": {
623
- "type": "string"
624
- },
625
- "permanent": {
626
- "type": "boolean"
627
- }
628
- },
629
- "required": ["source", "destination"],
630
- "additionalProperties": false
631
- }
632
- },
633
- "integrations": {
634
- "type": "object",
635
- "properties": {
636
- "adobe": {
637
- "type": "object",
638
- "properties": {
639
- "launchUrl": {
640
- "type": "string",
641
- "format": "uri"
642
- }
643
- },
644
- "required": ["launchUrl"],
645
- "additionalProperties": false
646
- },
647
- "amplitude": {
648
- "type": "object",
649
- "properties": {
650
- "apiKey": {
651
- "type": "string"
652
- }
653
- },
654
- "required": ["apiKey"],
655
- "additionalProperties": false
656
- },
657
- "clarity": {
658
- "type": "object",
659
- "properties": {
660
- "projectId": {
661
- "type": "string"
662
- }
663
- },
664
- "required": ["projectId"],
665
- "additionalProperties": false
666
- },
667
- "clearbit": {
668
- "type": "object",
669
- "properties": {
670
- "publicApiKey": {
671
- "type": "string"
672
- }
673
- },
674
- "required": ["publicApiKey"],
675
- "additionalProperties": false
676
- },
677
- "fathom": {
678
- "type": "object",
679
- "properties": {
680
- "siteId": {
681
- "type": "string"
682
- }
683
- },
684
- "required": ["siteId"],
685
- "additionalProperties": false
686
- },
687
- "frontchat": {
688
- "type": "object",
689
- "properties": {
690
- "snippetId": {
691
- "type": "string",
692
- "minLength": 6
693
- }
694
- },
695
- "required": ["snippetId"],
696
- "additionalProperties": false
697
- },
698
- "ga4": {
699
- "type": "object",
700
- "properties": {
701
- "measurementId": {
702
- "type": "string",
703
- "pattern": "^G"
704
- }
705
- },
706
- "required": ["measurementId"],
707
- "additionalProperties": false
708
- },
709
- "gtm": {
710
- "type": "object",
711
- "properties": {
712
- "tagId": {
713
- "type": "string",
714
- "pattern": "^G"
715
- }
716
- },
717
- "required": ["tagId"],
718
- "additionalProperties": false
719
- },
720
- "heap": {
721
- "type": "object",
722
- "properties": {
723
- "appId": {
724
- "type": "string"
725
- }
726
- },
727
- "required": ["appId"],
728
- "additionalProperties": false
729
- },
730
- "hightouch": {
731
- "type": "object",
732
- "properties": {
733
- "writeKey": {
734
- "type": "string"
735
- },
736
- "apiHost": {
737
- "type": "string"
738
- }
739
- },
740
- "required": ["writeKey"],
741
- "additionalProperties": false
742
- },
743
- "hotjar": {
744
- "type": "object",
745
- "properties": {
746
- "hjid": {
747
- "type": "string"
748
- },
749
- "hjsv": {
750
- "type": "string"
751
- }
752
- },
753
- "required": ["hjid", "hjsv"],
754
- "additionalProperties": false
755
- },
756
- "intercom": {
757
- "type": "object",
758
- "properties": {
759
- "appId": {
760
- "type": "string",
761
- "minLength": 6
762
- }
763
- },
764
- "required": ["appId"],
765
- "additionalProperties": false
766
- },
767
- "koala": {
768
- "type": "object",
769
- "properties": {
770
- "publicApiKey": {
771
- "type": "string",
772
- "minLength": 2
773
- }
774
- },
775
- "required": ["publicApiKey"],
776
- "additionalProperties": false
777
- },
778
- "logrocket": {
779
- "type": "object",
780
- "properties": {
781
- "appId": {
782
- "type": "string"
783
- }
784
- },
785
- "required": ["appId"],
786
- "additionalProperties": false
787
- },
788
- "mixpanel": {
789
- "type": "object",
790
- "properties": {
791
- "projectToken": {
792
- "type": "string"
793
- }
794
- },
795
- "required": ["projectToken"],
796
- "additionalProperties": false
797
- },
798
- "pirsch": {
799
- "type": "object",
800
- "properties": {
801
- "id": {
802
- "type": "string"
803
- }
804
- },
805
- "required": ["id"],
806
- "additionalProperties": false
807
- },
808
- "posthog": {
809
- "type": "object",
810
- "properties": {
811
- "apiKey": {
812
- "type": "string",
813
- "pattern": "^phc\\_"
814
- },
815
- "apiHost": {
816
- "type": "string",
817
- "format": "uri"
818
- },
819
- "sessionRecording": {
820
- "type": "boolean"
821
- }
822
- },
823
- "required": ["apiKey"],
824
- "additionalProperties": false
825
- },
826
- "plausible": {
827
- "type": "object",
828
- "properties": {
829
- "domain": {
830
- "type": "string"
831
- },
832
- "server": {
833
- "type": "string"
834
- }
835
- },
836
- "required": ["domain"],
837
- "additionalProperties": false
838
- },
839
- "segment": {
840
- "type": "object",
841
- "properties": {
842
- "key": {
843
- "type": "string"
844
- }
845
- },
846
- "required": ["key"],
847
- "additionalProperties": false
848
- },
849
- "telemetry": {
850
- "type": "object",
851
- "properties": {
852
- "enabled": {
853
- "type": "boolean"
854
- }
855
- },
856
- "additionalProperties": false
857
- },
858
- "cookies": {
859
- "type": "object",
860
- "properties": {
861
- "key": {
862
- "type": "string"
863
- },
864
- "value": {
865
- "type": "string"
866
- }
867
- },
868
- "additionalProperties": false
869
- }
870
- },
871
- "additionalProperties": false,
872
- "description": "Configurations for official integrations"
873
- },
874
- "banner": {
875
- "$ref": "#/definitions/anchorSchema/anyOf/0/properties/global/properties/languages/items/properties/banner"
876
- },
877
- "errors": {
878
- "type": "object",
879
- "properties": {
880
- "404": {
881
- "type": "object",
882
- "properties": {
883
- "redirect": {
884
- "type": "boolean",
885
- "default": true,
886
- "description": "Whether to redirect to the home page, if the page is not found"
887
- },
888
- "title": {
889
- "type": "string",
890
- "description": "The title of the error page"
891
- },
892
- "description": {
893
- "type": "string",
894
- "description": "The description of the error page. Supports MDX formatting including links, bold, italic text, and custom components."
895
- }
896
- },
897
- "additionalProperties": false
898
- }
899
- },
900
- "required": ["404"],
901
- "additionalProperties": false,
902
- "description": "Error pages configuration"
903
- },
904
- "contextual": {
905
- "type": "object",
906
- "properties": {
907
- "options": {
908
- "type": "array",
909
- "items": {
910
- "anyOf": [
911
- {
912
- "type": "string",
913
- "enum": [
914
- "assistant",
915
- "copy",
916
- "view",
917
- "chatgpt",
918
- "claude",
919
- "perplexity",
920
- "grok",
921
- "aistudio",
922
- "devin",
923
- "windsurf",
924
- "mcp",
925
- "add-mcp",
926
- "cursor",
927
- "vscode",
928
- "devin-mcp"
929
- ]
930
- },
931
- {
932
- "type": "object",
933
- "properties": {
934
- "title": {
935
- "type": "string"
936
- },
937
- "description": {
938
- "type": "string"
939
- },
940
- "icon": {
941
- "$ref": "#/definitions/anchorSchema/anyOf/0/properties/icon",
942
- "description": "The icon to be displayed in the section"
943
- },
944
- "href": {
945
- "anyOf": [
946
- {
947
- "type": "string"
948
- },
949
- {
950
- "type": "object",
951
- "properties": {
952
- "base": {
953
- "type": "string"
954
- },
955
- "query": {
956
- "type": "array",
957
- "items": {
958
- "type": "object",
959
- "properties": {
960
- "key": {
961
- "type": "string"
962
- },
963
- "value": {
964
- "type": "string"
965
- }
966
- },
967
- "required": ["key", "value"],
968
- "additionalProperties": false
969
- }
970
- }
971
- },
972
- "required": ["base"],
973
- "additionalProperties": false
974
- }
975
- ]
976
- }
977
- },
978
- "required": ["title", "description", "href"],
979
- "additionalProperties": false,
980
- "description": "Custom contextual option"
981
- }
982
- ]
983
- },
984
- "description": "Contextual options"
985
- },
986
- "display": {
987
- "type": "string",
988
- "enum": ["header", "toc"],
989
- "default": "header",
990
- "description": "Where to display the contextual options: \"header\" (default) shows them in the top-of-page context menu, \"toc\" shows them in the table of contents sidebar"
991
- }
992
- },
993
- "required": ["options"],
994
- "additionalProperties": false,
995
- "description": "Contextual options"
996
- },
997
- "thumbnails": {
998
- "type": "object",
999
- "properties": {
1000
- "appearance": {
1001
- "type": "string",
1002
- "enum": ["light", "dark"],
1003
- "description": "The appearance of the thumbnail. Defaults to generated by colors."
1004
- },
1005
- "background": {
1006
- "type": "string",
1007
- "description": "Background image for the thumbnail. Can be an absolute URL or relative path."
1008
- },
1009
- "fonts": {
1010
- "type": "object",
1011
- "properties": {
1012
- "family": {
1013
- "type": "string",
1014
- "description": "The font family, such as \"Open Sans\", \"Playfair Display\""
1015
- }
1016
- },
1017
- "required": ["family"],
1018
- "additionalProperties": false,
1019
- "description": "The font to be used for thumbnails. Only family name is supported for Google Fonts."
1020
- }
1021
- },
1022
- "additionalProperties": false
1023
- },
1024
- "interaction": {
1025
- "type": "object",
1026
- "properties": {
1027
- "drilldown": {
1028
- "type": "boolean",
1029
- "description": "Whether to automatically navigate to the first page when navigation groups are expanded"
1030
- }
1031
- },
1032
- "additionalProperties": false,
1033
- "description": "Options for how users interact with links in the documentation"
1034
- },
1035
- "metadata": {
1036
- "type": "object",
1037
- "properties": {
1038
- "timestamp": {
1039
- "type": "boolean",
1040
- "default": false,
1041
- "description": "When enabled, all pages will display the date the content was last modified. Default is false."
1042
- }
1043
- },
1044
- "additionalProperties": false,
1045
- "description": "Metadata configuration for documentation pages"
1046
- },
1047
- "variables": {
1048
- "type": "object",
1049
- "additionalProperties": {
1050
- "type": "string"
1051
- },
1052
- "description": "Set of custom variables used throughout your documentation."
1053
- }
1054
- },
1055
- "required": ["theme", "name", "colors", "navigation"],
1056
- "additionalProperties": false
1057
- },
1058
- {
1059
- "type": "object",
1060
- "properties": {
1061
- "theme": {
1062
- "type": "string",
1063
- "const": "maple"
1064
- },
1065
- "$schema": {
1066
- "$ref": "#/anyOf/0/properties/$schema"
1067
- },
1068
- "name": {
1069
- "$ref": "#/anyOf/0/properties/name"
1070
- },
1071
- "public": {
1072
- "$ref": "#/anyOf/0/properties/public"
1073
- },
1074
- "description": {
1075
- "$ref": "#/anyOf/0/properties/description"
1076
- },
1077
- "colors": {
1078
- "$ref": "#/definitions/colorsSchema"
1079
- },
1080
- "logo": {
1081
- "$ref": "#/anyOf/0/properties/logo"
1082
- },
1083
- "favicon": {
1084
- "$ref": "#/anyOf/0/properties/favicon"
1085
- },
1086
- "api": {
1087
- "$ref": "#/anyOf/0/properties/api"
1088
- },
1089
- "appearance": {
1090
- "$ref": "#/anyOf/0/properties/appearance"
1091
- },
1092
- "background": {
1093
- "$ref": "#/anyOf/0/properties/background"
1094
- },
1095
- "navbar": {
1096
- "$ref": "#/anyOf/0/properties/navbar"
1097
- },
1098
- "navigation": {
1099
- "$ref": "#/definitions/navigationSchema"
1100
- },
1101
- "footer": {
1102
- "$ref": "#/anyOf/0/properties/footer"
1103
- },
1104
- "search": {
1105
- "$ref": "#/anyOf/0/properties/search"
1106
- },
1107
- "seo": {
1108
- "$ref": "#/anyOf/0/properties/seo"
1109
- },
1110
- "fonts": {
1111
- "$ref": "#/anyOf/0/properties/fonts"
1112
- },
1113
- "icons": {
1114
- "$ref": "#/anyOf/0/properties/icons"
1115
- },
1116
- "styling": {
1117
- "$ref": "#/anyOf/0/properties/styling"
1118
- },
1119
- "redirects": {
1120
- "$ref": "#/anyOf/0/properties/redirects"
1121
- },
1122
- "integrations": {
1123
- "$ref": "#/anyOf/0/properties/integrations"
1124
- },
1125
- "banner": {
1126
- "$ref": "#/anyOf/0/properties/banner"
1127
- },
1128
- "errors": {
1129
- "$ref": "#/anyOf/0/properties/errors"
1130
- },
1131
- "contextual": {
1132
- "$ref": "#/anyOf/0/properties/contextual"
1133
- },
1134
- "thumbnails": {
1135
- "$ref": "#/anyOf/0/properties/thumbnails"
1136
- },
1137
- "interaction": {
1138
- "$ref": "#/anyOf/0/properties/interaction"
1139
- },
1140
- "metadata": {
1141
- "$ref": "#/anyOf/0/properties/metadata"
1142
- },
1143
- "variables": {
1144
- "$ref": "#/anyOf/0/properties/variables"
1145
- }
1146
- },
1147
- "required": ["theme", "name", "colors", "navigation"],
1148
- "additionalProperties": false
1149
- },
1150
- {
1151
- "type": "object",
1152
- "properties": {
1153
- "theme": {
1154
- "type": "string",
1155
- "const": "palm"
1156
- },
1157
- "$schema": {
1158
- "$ref": "#/anyOf/0/properties/$schema"
1159
- },
1160
- "name": {
1161
- "$ref": "#/anyOf/0/properties/name"
1162
- },
1163
- "public": {
1164
- "$ref": "#/anyOf/0/properties/public"
1165
- },
1166
- "description": {
1167
- "$ref": "#/anyOf/0/properties/description"
1168
- },
1169
- "colors": {
1170
- "$ref": "#/definitions/colorsSchema"
1171
- },
1172
- "logo": {
1173
- "$ref": "#/anyOf/0/properties/logo"
1174
- },
1175
- "favicon": {
1176
- "$ref": "#/anyOf/0/properties/favicon"
1177
- },
1178
- "api": {
1179
- "$ref": "#/anyOf/0/properties/api"
1180
- },
1181
- "appearance": {
1182
- "$ref": "#/anyOf/0/properties/appearance"
1183
- },
1184
- "background": {
1185
- "$ref": "#/anyOf/0/properties/background"
1186
- },
1187
- "navbar": {
1188
- "$ref": "#/anyOf/0/properties/navbar"
1189
- },
1190
- "navigation": {
1191
- "$ref": "#/definitions/navigationSchema"
1192
- },
1193
- "footer": {
1194
- "$ref": "#/anyOf/0/properties/footer"
1195
- },
1196
- "search": {
1197
- "$ref": "#/anyOf/0/properties/search"
1198
- },
1199
- "seo": {
1200
- "$ref": "#/anyOf/0/properties/seo"
1201
- },
1202
- "fonts": {
1203
- "$ref": "#/anyOf/0/properties/fonts"
1204
- },
1205
- "icons": {
1206
- "$ref": "#/anyOf/0/properties/icons"
1207
- },
1208
- "styling": {
1209
- "$ref": "#/anyOf/0/properties/styling"
1210
- },
1211
- "redirects": {
1212
- "$ref": "#/anyOf/0/properties/redirects"
1213
- },
1214
- "integrations": {
1215
- "$ref": "#/anyOf/0/properties/integrations"
1216
- },
1217
- "banner": {
1218
- "$ref": "#/anyOf/0/properties/banner"
1219
- },
1220
- "errors": {
1221
- "$ref": "#/anyOf/0/properties/errors"
1222
- },
1223
- "contextual": {
1224
- "$ref": "#/anyOf/0/properties/contextual"
1225
- },
1226
- "thumbnails": {
1227
- "$ref": "#/anyOf/0/properties/thumbnails"
1228
- },
1229
- "interaction": {
1230
- "$ref": "#/anyOf/0/properties/interaction"
1231
- },
1232
- "metadata": {
1233
- "$ref": "#/anyOf/0/properties/metadata"
1234
- },
1235
- "variables": {
1236
- "$ref": "#/anyOf/0/properties/variables"
1237
- }
1238
- },
1239
- "required": ["theme", "name", "colors", "navigation"],
1240
- "additionalProperties": false
1241
- },
1242
- {
1243
- "type": "object",
1244
- "properties": {
1245
- "theme": {
1246
- "type": "string",
1247
- "const": "willow"
1248
- },
1249
- "$schema": {
1250
- "$ref": "#/anyOf/0/properties/$schema"
1251
- },
1252
- "name": {
1253
- "$ref": "#/anyOf/0/properties/name"
1254
- },
1255
- "public": {
1256
- "$ref": "#/anyOf/0/properties/public"
1257
- },
1258
- "description": {
1259
- "$ref": "#/anyOf/0/properties/description"
1260
- },
1261
- "colors": {
1262
- "$ref": "#/definitions/colorsSchema"
1263
- },
1264
- "logo": {
1265
- "$ref": "#/anyOf/0/properties/logo"
1266
- },
1267
- "favicon": {
1268
- "$ref": "#/anyOf/0/properties/favicon"
1269
- },
1270
- "api": {
1271
- "$ref": "#/anyOf/0/properties/api"
1272
- },
1273
- "appearance": {
1274
- "$ref": "#/anyOf/0/properties/appearance"
1275
- },
1276
- "background": {
1277
- "$ref": "#/anyOf/0/properties/background"
1278
- },
1279
- "navbar": {
1280
- "$ref": "#/anyOf/0/properties/navbar"
1281
- },
1282
- "navigation": {
1283
- "$ref": "#/definitions/navigationSchema"
1284
- },
1285
- "footer": {
1286
- "$ref": "#/anyOf/0/properties/footer"
1287
- },
1288
- "search": {
1289
- "$ref": "#/anyOf/0/properties/search"
1290
- },
1291
- "seo": {
1292
- "$ref": "#/anyOf/0/properties/seo"
1293
- },
1294
- "fonts": {
1295
- "$ref": "#/anyOf/0/properties/fonts"
1296
- },
1297
- "icons": {
1298
- "$ref": "#/anyOf/0/properties/icons"
1299
- },
1300
- "styling": {
1301
- "$ref": "#/anyOf/0/properties/styling"
1302
- },
1303
- "redirects": {
1304
- "$ref": "#/anyOf/0/properties/redirects"
1305
- },
1306
- "integrations": {
1307
- "$ref": "#/anyOf/0/properties/integrations"
1308
- },
1309
- "banner": {
1310
- "$ref": "#/anyOf/0/properties/banner"
1311
- },
1312
- "errors": {
1313
- "$ref": "#/anyOf/0/properties/errors"
1314
- },
1315
- "contextual": {
1316
- "$ref": "#/anyOf/0/properties/contextual"
1317
- },
1318
- "thumbnails": {
1319
- "$ref": "#/anyOf/0/properties/thumbnails"
1320
- },
1321
- "interaction": {
1322
- "$ref": "#/anyOf/0/properties/interaction"
1323
- },
1324
- "metadata": {
1325
- "$ref": "#/anyOf/0/properties/metadata"
1326
- },
1327
- "variables": {
1328
- "$ref": "#/anyOf/0/properties/variables"
1329
- }
1330
- },
1331
- "required": ["theme", "name", "colors", "navigation"],
1332
- "additionalProperties": false
1333
- },
1334
- {
1335
- "type": "object",
1336
- "properties": {
1337
- "theme": {
1338
- "type": "string",
1339
- "const": "linden"
1340
- },
1341
- "$schema": {
1342
- "$ref": "#/anyOf/0/properties/$schema"
1343
- },
1344
- "name": {
1345
- "$ref": "#/anyOf/0/properties/name"
1346
- },
1347
- "public": {
1348
- "$ref": "#/anyOf/0/properties/public"
1349
- },
1350
- "description": {
1351
- "$ref": "#/anyOf/0/properties/description"
1352
- },
1353
- "colors": {
1354
- "$ref": "#/definitions/colorsSchema"
1355
- },
1356
- "logo": {
1357
- "$ref": "#/anyOf/0/properties/logo"
1358
- },
1359
- "favicon": {
1360
- "$ref": "#/anyOf/0/properties/favicon"
1361
- },
1362
- "api": {
1363
- "$ref": "#/anyOf/0/properties/api"
1364
- },
1365
- "appearance": {
1366
- "$ref": "#/anyOf/0/properties/appearance"
1367
- },
1368
- "background": {
1369
- "$ref": "#/anyOf/0/properties/background"
1370
- },
1371
- "navbar": {
1372
- "$ref": "#/anyOf/0/properties/navbar"
1373
- },
1374
- "navigation": {
1375
- "$ref": "#/definitions/navigationSchema"
1376
- },
1377
- "footer": {
1378
- "$ref": "#/anyOf/0/properties/footer"
1379
- },
1380
- "search": {
1381
- "$ref": "#/anyOf/0/properties/search"
1382
- },
1383
- "seo": {
1384
- "$ref": "#/anyOf/0/properties/seo"
1385
- },
1386
- "fonts": {
1387
- "$ref": "#/anyOf/0/properties/fonts"
1388
- },
1389
- "icons": {
1390
- "$ref": "#/anyOf/0/properties/icons"
1391
- },
1392
- "styling": {
1393
- "$ref": "#/anyOf/0/properties/styling"
1394
- },
1395
- "redirects": {
1396
- "$ref": "#/anyOf/0/properties/redirects"
1397
- },
1398
- "integrations": {
1399
- "$ref": "#/anyOf/0/properties/integrations"
1400
- },
1401
- "banner": {
1402
- "$ref": "#/anyOf/0/properties/banner"
1403
- },
1404
- "errors": {
1405
- "$ref": "#/anyOf/0/properties/errors"
1406
- },
1407
- "contextual": {
1408
- "$ref": "#/anyOf/0/properties/contextual"
1409
- },
1410
- "thumbnails": {
1411
- "$ref": "#/anyOf/0/properties/thumbnails"
1412
- },
1413
- "interaction": {
1414
- "$ref": "#/anyOf/0/properties/interaction"
1415
- },
1416
- "metadata": {
1417
- "$ref": "#/anyOf/0/properties/metadata"
1418
- },
1419
- "variables": {
1420
- "$ref": "#/anyOf/0/properties/variables"
1421
- }
1422
- },
1423
- "required": ["theme", "name", "colors", "navigation"],
1424
- "additionalProperties": false
1425
- },
1426
- {
1427
- "type": "object",
1428
- "properties": {
1429
- "theme": {
1430
- "type": "string",
1431
- "const": "almond"
1432
- },
1433
- "$schema": {
1434
- "$ref": "#/anyOf/0/properties/$schema"
1435
- },
1436
- "name": {
1437
- "$ref": "#/anyOf/0/properties/name"
1438
- },
1439
- "public": {
1440
- "$ref": "#/anyOf/0/properties/public"
1441
- },
1442
- "description": {
1443
- "$ref": "#/anyOf/0/properties/description"
1444
- },
1445
- "colors": {
1446
- "$ref": "#/definitions/colorsSchema"
1447
- },
1448
- "logo": {
1449
- "$ref": "#/anyOf/0/properties/logo"
1450
- },
1451
- "favicon": {
1452
- "$ref": "#/anyOf/0/properties/favicon"
1453
- },
1454
- "api": {
1455
- "$ref": "#/anyOf/0/properties/api"
1456
- },
1457
- "appearance": {
1458
- "$ref": "#/anyOf/0/properties/appearance"
1459
- },
1460
- "background": {
1461
- "$ref": "#/anyOf/0/properties/background"
1462
- },
1463
- "navbar": {
1464
- "$ref": "#/anyOf/0/properties/navbar"
1465
- },
1466
- "navigation": {
1467
- "$ref": "#/definitions/navigationSchema"
1468
- },
1469
- "footer": {
1470
- "$ref": "#/anyOf/0/properties/footer"
1471
- },
1472
- "search": {
1473
- "$ref": "#/anyOf/0/properties/search"
1474
- },
1475
- "seo": {
1476
- "$ref": "#/anyOf/0/properties/seo"
1477
- },
1478
- "fonts": {
1479
- "$ref": "#/anyOf/0/properties/fonts"
1480
- },
1481
- "icons": {
1482
- "$ref": "#/anyOf/0/properties/icons"
1483
- },
1484
- "styling": {
1485
- "$ref": "#/anyOf/0/properties/styling"
1486
- },
1487
- "redirects": {
1488
- "$ref": "#/anyOf/0/properties/redirects"
1489
- },
1490
- "integrations": {
1491
- "$ref": "#/anyOf/0/properties/integrations"
1492
- },
1493
- "banner": {
1494
- "$ref": "#/anyOf/0/properties/banner"
1495
- },
1496
- "errors": {
1497
- "$ref": "#/anyOf/0/properties/errors"
1498
- },
1499
- "contextual": {
1500
- "$ref": "#/anyOf/0/properties/contextual"
1501
- },
1502
- "thumbnails": {
1503
- "$ref": "#/anyOf/0/properties/thumbnails"
1504
- },
1505
- "interaction": {
1506
- "$ref": "#/anyOf/0/properties/interaction"
1507
- },
1508
- "metadata": {
1509
- "$ref": "#/anyOf/0/properties/metadata"
1510
- },
1511
- "variables": {
1512
- "$ref": "#/anyOf/0/properties/variables"
1513
- }
1514
- },
1515
- "required": ["theme", "name", "colors", "navigation"],
1516
- "additionalProperties": false
1517
- },
1518
- {
1519
- "type": "object",
1520
- "properties": {
1521
- "theme": {
1522
- "type": "string",
1523
- "const": "aspen"
1524
- },
1525
- "$schema": {
1526
- "$ref": "#/anyOf/0/properties/$schema"
1527
- },
1528
- "name": {
1529
- "$ref": "#/anyOf/0/properties/name"
1530
- },
1531
- "public": {
1532
- "$ref": "#/anyOf/0/properties/public"
1533
- },
1534
- "description": {
1535
- "$ref": "#/anyOf/0/properties/description"
1536
- },
1537
- "colors": {
1538
- "$ref": "#/definitions/colorsSchema"
1539
- },
1540
- "logo": {
1541
- "$ref": "#/anyOf/0/properties/logo"
1542
- },
1543
- "favicon": {
1544
- "$ref": "#/anyOf/0/properties/favicon"
1545
- },
1546
- "api": {
1547
- "$ref": "#/anyOf/0/properties/api"
1548
- },
1549
- "appearance": {
1550
- "$ref": "#/anyOf/0/properties/appearance"
1551
- },
1552
- "background": {
1553
- "$ref": "#/anyOf/0/properties/background"
1554
- },
1555
- "navbar": {
1556
- "$ref": "#/anyOf/0/properties/navbar"
1557
- },
1558
- "navigation": {
1559
- "$ref": "#/definitions/navigationSchema"
1560
- },
1561
- "footer": {
1562
- "$ref": "#/anyOf/0/properties/footer"
1563
- },
1564
- "search": {
1565
- "$ref": "#/anyOf/0/properties/search"
1566
- },
1567
- "seo": {
1568
- "$ref": "#/anyOf/0/properties/seo"
1569
- },
1570
- "fonts": {
1571
- "$ref": "#/anyOf/0/properties/fonts"
1572
- },
1573
- "icons": {
1574
- "$ref": "#/anyOf/0/properties/icons"
1575
- },
1576
- "styling": {
1577
- "$ref": "#/anyOf/0/properties/styling"
1578
- },
1579
- "redirects": {
1580
- "$ref": "#/anyOf/0/properties/redirects"
1581
- },
1582
- "integrations": {
1583
- "$ref": "#/anyOf/0/properties/integrations"
1584
- },
1585
- "banner": {
1586
- "$ref": "#/anyOf/0/properties/banner"
1587
- },
1588
- "errors": {
1589
- "$ref": "#/anyOf/0/properties/errors"
1590
- },
1591
- "contextual": {
1592
- "$ref": "#/anyOf/0/properties/contextual"
1593
- },
1594
- "thumbnails": {
1595
- "$ref": "#/anyOf/0/properties/thumbnails"
1596
- },
1597
- "interaction": {
1598
- "$ref": "#/anyOf/0/properties/interaction"
1599
- },
1600
- "metadata": {
1601
- "$ref": "#/anyOf/0/properties/metadata"
1602
- },
1603
- "variables": {
1604
- "$ref": "#/anyOf/0/properties/variables"
1605
- }
1606
- },
1607
- "required": ["theme", "name", "colors", "navigation"],
1608
- "additionalProperties": false
1609
- },
1610
- {
1611
- "type": "object",
1612
- "properties": {
1613
- "theme": {
1614
- "type": "string",
1615
- "const": "luma"
1616
- },
1617
- "$schema": {
1618
- "$ref": "#/anyOf/0/properties/$schema"
1619
- },
1620
- "name": {
1621
- "$ref": "#/anyOf/0/properties/name"
1622
- },
1623
- "public": {
1624
- "$ref": "#/anyOf/0/properties/public"
1625
- },
1626
- "description": {
1627
- "$ref": "#/anyOf/0/properties/description"
1628
- },
1629
- "colors": {
1630
- "$ref": "#/definitions/colorsSchema"
1631
- },
1632
- "logo": {
1633
- "$ref": "#/anyOf/0/properties/logo"
1634
- },
1635
- "favicon": {
1636
- "$ref": "#/anyOf/0/properties/favicon"
1637
- },
1638
- "api": {
1639
- "$ref": "#/anyOf/0/properties/api"
1640
- },
1641
- "appearance": {
1642
- "$ref": "#/anyOf/0/properties/appearance"
1643
- },
1644
- "background": {
1645
- "$ref": "#/anyOf/0/properties/background"
1646
- },
1647
- "navbar": {
1648
- "$ref": "#/anyOf/0/properties/navbar"
1649
- },
1650
- "navigation": {
1651
- "$ref": "#/definitions/navigationSchema"
1652
- },
1653
- "footer": {
1654
- "$ref": "#/anyOf/0/properties/footer"
1655
- },
1656
- "search": {
1657
- "$ref": "#/anyOf/0/properties/search"
1658
- },
1659
- "seo": {
1660
- "$ref": "#/anyOf/0/properties/seo"
1661
- },
1662
- "fonts": {
1663
- "$ref": "#/anyOf/0/properties/fonts"
1664
- },
1665
- "icons": {
1666
- "$ref": "#/anyOf/0/properties/icons"
1667
- },
1668
- "styling": {
1669
- "$ref": "#/anyOf/0/properties/styling"
1670
- },
1671
- "redirects": {
1672
- "$ref": "#/anyOf/0/properties/redirects"
1673
- },
1674
- "integrations": {
1675
- "$ref": "#/anyOf/0/properties/integrations"
1676
- },
1677
- "banner": {
1678
- "$ref": "#/anyOf/0/properties/banner"
1679
- },
1680
- "errors": {
1681
- "$ref": "#/anyOf/0/properties/errors"
1682
- },
1683
- "contextual": {
1684
- "$ref": "#/anyOf/0/properties/contextual"
1685
- },
1686
- "thumbnails": {
1687
- "$ref": "#/anyOf/0/properties/thumbnails"
1688
- },
1689
- "interaction": {
1690
- "$ref": "#/anyOf/0/properties/interaction"
1691
- },
1692
- "metadata": {
1693
- "$ref": "#/anyOf/0/properties/metadata"
1694
- },
1695
- "variables": {
1696
- "$ref": "#/anyOf/0/properties/variables"
1697
- }
1698
- },
1699
- "required": ["theme", "name", "colors", "navigation"],
1700
- "additionalProperties": false
1701
- },
1702
- {
1703
- "type": "object",
1704
- "properties": {
1705
- "theme": {
1706
- "type": "string",
1707
- "const": "sequoia"
1708
- },
1709
- "$schema": {
1710
- "$ref": "#/anyOf/0/properties/$schema"
1711
- },
1712
- "name": {
1713
- "$ref": "#/anyOf/0/properties/name"
1714
- },
1715
- "public": {
1716
- "$ref": "#/anyOf/0/properties/public"
1717
- },
1718
- "description": {
1719
- "$ref": "#/anyOf/0/properties/description"
1720
- },
1721
- "colors": {
1722
- "$ref": "#/definitions/colorsSchema"
1723
- },
1724
- "logo": {
1725
- "$ref": "#/anyOf/0/properties/logo"
1726
- },
1727
- "favicon": {
1728
- "$ref": "#/anyOf/0/properties/favicon"
1729
- },
1730
- "api": {
1731
- "$ref": "#/anyOf/0/properties/api"
1732
- },
1733
- "appearance": {
1734
- "$ref": "#/anyOf/0/properties/appearance"
1735
- },
1736
- "background": {
1737
- "$ref": "#/anyOf/0/properties/background"
1738
- },
1739
- "navbar": {
1740
- "$ref": "#/anyOf/0/properties/navbar"
1741
- },
1742
- "navigation": {
1743
- "$ref": "#/definitions/navigationSchema"
1744
- },
1745
- "footer": {
1746
- "$ref": "#/anyOf/0/properties/footer"
1747
- },
1748
- "search": {
1749
- "$ref": "#/anyOf/0/properties/search"
1750
- },
1751
- "seo": {
1752
- "$ref": "#/anyOf/0/properties/seo"
1753
- },
1754
- "fonts": {
1755
- "$ref": "#/anyOf/0/properties/fonts"
1756
- },
1757
- "icons": {
1758
- "$ref": "#/anyOf/0/properties/icons"
1759
- },
1760
- "styling": {
1761
- "$ref": "#/anyOf/0/properties/styling"
1762
- },
1763
- "redirects": {
1764
- "$ref": "#/anyOf/0/properties/redirects"
1765
- },
1766
- "integrations": {
1767
- "$ref": "#/anyOf/0/properties/integrations"
1768
- },
1769
- "banner": {
1770
- "$ref": "#/anyOf/0/properties/banner"
1771
- },
1772
- "errors": {
1773
- "$ref": "#/anyOf/0/properties/errors"
1774
- },
1775
- "contextual": {
1776
- "$ref": "#/anyOf/0/properties/contextual"
1777
- },
1778
- "thumbnails": {
1779
- "$ref": "#/anyOf/0/properties/thumbnails"
1780
- },
1781
- "interaction": {
1782
- "$ref": "#/anyOf/0/properties/interaction"
1783
- },
1784
- "metadata": {
1785
- "$ref": "#/anyOf/0/properties/metadata"
1786
- },
1787
- "variables": {
1788
- "$ref": "#/anyOf/0/properties/variables"
1789
- }
1790
- },
1791
- "required": ["theme", "name", "colors", "navigation"],
1792
- "additionalProperties": false
1793
- }
1794
- ],
2
+ "$id": "https://blode.md/docs.json",
3
+ "$schema": "http://json-schema.org/draft-07/schema#",
4
+ "additionalProperties": false,
1795
5
  "definitions": {
1796
6
  "anchorSchema": {
1797
7
  "anyOf": [
@@ -5012,5 +3222,347 @@
5012
3222
  "$ref": "#/definitions/anchorSchema/anyOf/1/properties/languages/items/anyOf/1/properties/versions"
5013
3223
  }
5014
3224
  },
5015
- "$schema": "http://json-schema.org/draft-07/schema#"
3225
+ "description": "Schema for Blode.md docs.json configuration files. Derived from the vendored Mintlify schema and pruned to the supported Blode.md surface.",
3226
+ "properties": {
3227
+ "$schema": {
3228
+ "type": "string",
3229
+ "format": "uri",
3230
+ "default": "https://blode.md/docs.json",
3231
+ "description": "JSON Schema URL for editor autocomplete."
3232
+ },
3233
+ "name": {
3234
+ "type": "string",
3235
+ "minLength": 1,
3236
+ "description": "The name of the project, organization, or product"
3237
+ },
3238
+ "description": {
3239
+ "type": "string",
3240
+ "description": "Optional description used for SEO and LLM indexing"
3241
+ },
3242
+ "logo": {
3243
+ "anyOf": [
3244
+ {
3245
+ "type": "string",
3246
+ "minLength": 3,
3247
+ "description": "The logo (for both light and dark mode)"
3248
+ },
3249
+ {
3250
+ "type": "object",
3251
+ "properties": {
3252
+ "light": {
3253
+ "type": "string",
3254
+ "description": "Path pointing to the light logo file to use in dark mode, including the file extension. Example: `/logo.png`"
3255
+ },
3256
+ "dark": {
3257
+ "type": "string",
3258
+ "description": "Path pointing to the dark logo file to use in light mode, including the file extension. Example: `/logo-dark.png`"
3259
+ },
3260
+ "href": {
3261
+ "$ref": "#/definitions/anchorSchema/anyOf/0/properties/href",
3262
+ "description": "The URL to redirect to when clicking the logo. If not provided, the logo will link to the homepage. Example: `https://example.com`"
3263
+ }
3264
+ },
3265
+ "required": ["light", "dark"],
3266
+ "additionalProperties": false
3267
+ }
3268
+ ],
3269
+ "description": "Your site logo. Provide a single image path or separate files for light and dark mode."
3270
+ },
3271
+ "favicon": {
3272
+ "anyOf": [
3273
+ {
3274
+ "type": "string",
3275
+ "description": "Path pointing to the favicon file in your docs folder, including the file extension. The favicon will automatically be resized to the appropriate sizes"
3276
+ },
3277
+ {
3278
+ "type": "object",
3279
+ "properties": {
3280
+ "light": {
3281
+ "type": "string",
3282
+ "description": "Path pointing to the light favicon file to use in dark mode, including the file extension. Example: `/favicon.png`"
3283
+ },
3284
+ "dark": {
3285
+ "type": "string",
3286
+ "description": "Path pointing to the dark favicon file to use in light mode, including the file extension. Example: `/favicon-dark.png`"
3287
+ }
3288
+ },
3289
+ "required": ["light", "dark"],
3290
+ "additionalProperties": false,
3291
+ "description": "The path to the favicon. Can be a single file or a pair for light and dark mode. Example: `/favicon.png`"
3292
+ }
3293
+ ],
3294
+ "description": "Path to your favicon file, including the file extension. Provide a single file or separate files for light and dark mode."
3295
+ },
3296
+ "api": {
3297
+ "type": "object",
3298
+ "properties": {
3299
+ "openapi": {
3300
+ "$ref": "#/definitions/anchorSchema/anyOf/0/properties/openapi",
3301
+ "description": "A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s)"
3302
+ },
3303
+ "asyncapi": {
3304
+ "$ref": "#/definitions/anchorSchema/anyOf/0/properties/asyncapi",
3305
+ "description": "A string or an array of strings of absolute or relative urls pointing to the AsyncAPI file(s)"
3306
+ },
3307
+ "params": {
3308
+ "type": "object",
3309
+ "properties": {
3310
+ "expanded": {
3311
+ "type": "string",
3312
+ "enum": ["all", "closed"],
3313
+ "description": "The view mode of the API parameters. Defaults to `closed`."
3314
+ }
3315
+ },
3316
+ "additionalProperties": false,
3317
+ "description": "Configurations for the API parameters"
3318
+ },
3319
+ "playground": {
3320
+ "type": "object",
3321
+ "properties": {
3322
+ "display": {
3323
+ "type": "string",
3324
+ "enum": ["interactive", "simple", "none", "auth"],
3325
+ "description": "The display mode of the API playground. Defaults to `interactive`. Use `auth` to show the playground only to authenticated users."
3326
+ },
3327
+ "proxy": {
3328
+ "type": "boolean",
3329
+ "description": "Whether to pass API requests through a proxy server. Defaults to `true`."
3330
+ },
3331
+ "credentials": {
3332
+ "type": "boolean",
3333
+ "description": "Whether to include cookies/auth for cross-origin requests when proxy is disabled. Defaults to `false`."
3334
+ }
3335
+ },
3336
+ "additionalProperties": false,
3337
+ "description": "Configurations for the API playground"
3338
+ },
3339
+ "examples": {
3340
+ "type": "object",
3341
+ "properties": {
3342
+ "defaults": {
3343
+ "type": "string",
3344
+ "enum": ["required", "all"],
3345
+ "description": "Whether to show only required parameters in the examples, defaults to `all`."
3346
+ },
3347
+ "languages": {
3348
+ "type": "array",
3349
+ "items": {
3350
+ "type": "string"
3351
+ },
3352
+ "description": "Example languages for the autogenerated API snippets"
3353
+ },
3354
+ "prefill": {
3355
+ "type": "boolean",
3356
+ "description": "Whether to prefill the API playground with the examples"
3357
+ },
3358
+ "autogenerate": {
3359
+ "type": "boolean",
3360
+ "description": "Whether to generate code samples for API endpoints. Defaults to `true`. If `false`, only manually-written code samples (from either `x-codeSamples` property in the OpenAPI spec or `<RequestExample>` components in the MDX files) will be shown."
3361
+ }
3362
+ },
3363
+ "additionalProperties": false,
3364
+ "description": "Configurations for the autogenerated API examples"
3365
+ },
3366
+ "url": {
3367
+ "type": "string",
3368
+ "enum": ["full"],
3369
+ "description": "The display mode of the base URL in the endpoint header. Set to `full` to always show the full base URL on every endpoint page."
3370
+ },
3371
+ "mdx": {
3372
+ "type": "object",
3373
+ "properties": {
3374
+ "auth": {
3375
+ "type": "object",
3376
+ "properties": {
3377
+ "method": {
3378
+ "type": "string",
3379
+ "enum": ["bearer", "basic", "key", "cobo"],
3380
+ "description": "Authentication method for the API"
3381
+ },
3382
+ "name": {
3383
+ "type": "string",
3384
+ "description": "Authentication name for the API"
3385
+ }
3386
+ },
3387
+ "additionalProperties": false,
3388
+ "description": "Authentication configuration for the API"
3389
+ },
3390
+ "server": {
3391
+ "anyOf": [
3392
+ {
3393
+ "type": "string",
3394
+ "format": "uri"
3395
+ },
3396
+ {
3397
+ "type": "array",
3398
+ "items": {
3399
+ "type": "string",
3400
+ "format": "uri"
3401
+ }
3402
+ }
3403
+ ],
3404
+ "description": "Base URL(s) for the API"
3405
+ }
3406
+ },
3407
+ "additionalProperties": false,
3408
+ "description": "Configurations for API pages generated from MDX files"
3409
+ }
3410
+ },
3411
+ "additionalProperties": false,
3412
+ "description": "API reference configuration and playground settings"
3413
+ },
3414
+ "appearance": {
3415
+ "type": "object",
3416
+ "properties": {
3417
+ "default": {
3418
+ "type": "string",
3419
+ "enum": ["system", "light", "dark"],
3420
+ "description": "The default light/dark mode. Defaults to system"
3421
+ },
3422
+ "strict": {
3423
+ "type": "boolean",
3424
+ "description": "Whether to hide the light / dark mode toggle. Defaults to `false`."
3425
+ }
3426
+ },
3427
+ "additionalProperties": false,
3428
+ "description": "Light and dark mode settings."
3429
+ },
3430
+ "navbar": {
3431
+ "$ref": "#/definitions/anchorSchema/anyOf/0/properties/global/properties/languages/items/properties/navbar",
3432
+ "description": "Navbar content and settings"
3433
+ },
3434
+ "navigation": {
3435
+ "$ref": "#/definitions/navigationSchema"
3436
+ },
3437
+ "search": {
3438
+ "type": "object",
3439
+ "properties": {
3440
+ "prompt": {
3441
+ "type": "string",
3442
+ "description": "The prompt to be displayed in the search bar placeholder"
3443
+ }
3444
+ },
3445
+ "additionalProperties": false,
3446
+ "description": "Search display settings"
3447
+ },
3448
+ "seo": {
3449
+ "additionalProperties": false,
3450
+ "description": "SEO indexing configuration.",
3451
+ "properties": {
3452
+ "indexing": {
3453
+ "description": "Set `all` to index every page, or `default` to respect page-level `noindex` frontmatter.",
3454
+ "enum": ["all", "default"],
3455
+ "type": "string"
3456
+ }
3457
+ },
3458
+ "type": "object"
3459
+ },
3460
+ "contextual": {
3461
+ "type": "object",
3462
+ "properties": {
3463
+ "options": {
3464
+ "type": "array",
3465
+ "items": {
3466
+ "anyOf": [
3467
+ {
3468
+ "type": "string",
3469
+ "enum": [
3470
+ "add-mcp",
3471
+ "aistudio",
3472
+ "assistant",
3473
+ "chatgpt",
3474
+ "claude",
3475
+ "copy",
3476
+ "cursor",
3477
+ "devin",
3478
+ "devin-mcp",
3479
+ "grok",
3480
+ "mcp",
3481
+ "perplexity",
3482
+ "view",
3483
+ "vscode",
3484
+ "windsurf"
3485
+ ]
3486
+ },
3487
+ {
3488
+ "type": "object",
3489
+ "properties": {
3490
+ "title": {
3491
+ "type": "string"
3492
+ },
3493
+ "description": {
3494
+ "type": "string"
3495
+ },
3496
+ "icon": {
3497
+ "$ref": "#/definitions/anchorSchema/anyOf/0/properties/icon",
3498
+ "description": "The icon to be displayed in the section"
3499
+ },
3500
+ "href": {
3501
+ "anyOf": [
3502
+ {
3503
+ "type": "string"
3504
+ },
3505
+ {
3506
+ "type": "object",
3507
+ "properties": {
3508
+ "base": {
3509
+ "type": "string"
3510
+ },
3511
+ "query": {
3512
+ "type": "array",
3513
+ "items": {
3514
+ "type": "object",
3515
+ "properties": {
3516
+ "key": {
3517
+ "type": "string"
3518
+ },
3519
+ "value": {
3520
+ "type": "string"
3521
+ }
3522
+ },
3523
+ "required": ["key", "value"],
3524
+ "additionalProperties": false
3525
+ }
3526
+ }
3527
+ },
3528
+ "required": ["base"],
3529
+ "additionalProperties": false
3530
+ }
3531
+ ]
3532
+ }
3533
+ },
3534
+ "required": ["title", "description", "href"],
3535
+ "additionalProperties": false,
3536
+ "description": "Custom contextual option"
3537
+ }
3538
+ ]
3539
+ },
3540
+ "description": "Contextual options"
3541
+ },
3542
+ "display": {
3543
+ "type": "string",
3544
+ "enum": ["header", "toc"],
3545
+ "default": "header",
3546
+ "description": "Where to display the contextual options: \"header\" (default) shows them in the top-of-page context menu, \"toc\" shows them in the table of contents sidebar"
3547
+ }
3548
+ },
3549
+ "required": ["options"],
3550
+ "additionalProperties": false,
3551
+ "description": "Contextual options"
3552
+ },
3553
+ "metadata": {
3554
+ "type": "object",
3555
+ "properties": {
3556
+ "timestamp": {
3557
+ "type": "boolean",
3558
+ "default": false,
3559
+ "description": "When enabled, all pages will display the date the content was last modified. Default is false."
3560
+ }
3561
+ },
3562
+ "additionalProperties": false,
3563
+ "description": "Metadata configuration for documentation pages"
3564
+ }
3565
+ },
3566
+ "required": ["name", "navigation"],
3567
+ "type": "object"
5016
3568
  }