@tenphi/docs 0.12.0 → 0.15.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.
Files changed (27) hide show
  1. package/README.md +22 -0
  2. package/dist/config/index.d.ts +5 -3
  3. package/dist/config/index.d.ts.map +1 -1
  4. package/dist/config/index.js +2 -240
  5. package/dist/config/schema.json +623 -63
  6. package/dist/config-DoR8g9IM.js +655 -0
  7. package/dist/config-DoR8g9IM.js.map +1 -0
  8. package/dist/content/index.d.ts +1 -1
  9. package/dist/content/index.js +1 -1
  10. package/dist/content-BIpXueW7.js +1338 -0
  11. package/dist/content-BIpXueW7.js.map +1 -0
  12. package/dist/index.d.ts +27 -3
  13. package/dist/index.d.ts.map +1 -1
  14. package/dist/index.js +41 -199
  15. package/dist/index.js.map +1 -1
  16. package/dist/markdown/index.d.ts +7 -3
  17. package/dist/markdown/index.d.ts.map +1 -1
  18. package/dist/markdown/index.js +10 -7
  19. package/dist/markdown/index.js.map +1 -1
  20. package/dist/testing/index.js +1 -1
  21. package/dist/{types-m7SvwRsi.d.ts → types-B-msp1dH.d.ts} +70 -24
  22. package/dist/types-B-msp1dH.d.ts.map +1 -0
  23. package/package.json +11 -3
  24. package/dist/config/index.js.map +0 -1
  25. package/dist/content-oJ_TI-Qv.js +0 -786
  26. package/dist/content-oJ_TI-Qv.js.map +0 -1
  27. package/dist/types-m7SvwRsi.d.ts.map +0 -1
package/dist/config/schema.json CHANGED
@@ -9,21 +9,42 @@
9
9
  "type": "object",
10
10
  "additionalProperties": false,
11
11
  "properties": {
12
- "title": { "type": "string" },
13
- "version": { "type": "string" },
14
- "description": { "type": "string" },
15
- "url": { "type": "string", "format": "uri" },
16
- "repository": { "type": "string", "format": "uri" },
12
+ "title": {
13
+ "type": "string"
14
+ },
15
+ "version": {
16
+ "type": "string"
17
+ },
18
+ "description": {
19
+ "type": "string"
20
+ },
21
+ "url": {
22
+ "type": "string",
23
+ "format": "uri"
24
+ },
25
+ "repository": {
26
+ "type": "string",
27
+ "format": "uri"
28
+ },
17
29
  "favicon": {
18
30
  "oneOf": [
19
- { "type": "string", "minLength": 1 },
31
+ {
32
+ "type": "string",
33
+ "minLength": 1
34
+ },
20
35
  {
21
36
  "type": "object",
22
37
  "additionalProperties": false,
23
38
  "required": ["source"],
24
39
  "properties": {
25
- "source": { "type": "string", "minLength": 1 },
26
- "background": { "type": "string", "minLength": 1 }
40
+ "source": {
41
+ "type": "string",
42
+ "minLength": 1
43
+ },
44
+ "background": {
45
+ "type": "string",
46
+ "minLength": 1
47
+ }
27
48
  }
28
49
  }
29
50
  ]
@@ -37,12 +58,18 @@
37
58
  "additionalProperties": false,
38
59
  "required": ["tag"],
39
60
  "properties": {
40
- "tag": { "type": "string" },
61
+ "tag": {
62
+ "type": "string"
63
+ },
41
64
  "attrs": {
42
65
  "type": "object",
43
- "additionalProperties": { "type": ["string", "boolean"] }
66
+ "additionalProperties": {
67
+ "type": ["string", "boolean"]
68
+ }
44
69
  },
45
- "content": { "type": "string" }
70
+ "content": {
71
+ "type": "string"
72
+ }
46
73
  }
47
74
  }
48
75
  },
@@ -50,28 +77,57 @@
50
77
  "type": "object",
51
78
  "additionalProperties": false,
52
79
  "required": ["baseUrl"],
53
- "properties": { "baseUrl": { "type": "string", "format": "uri" } }
80
+ "properties": {
81
+ "baseUrl": {
82
+ "type": "string",
83
+ "format": "uri"
84
+ }
85
+ }
86
+ },
87
+ "lastUpdated": {
88
+ "type": "boolean",
89
+ "default": false
54
90
  },
55
- "lastUpdated": { "type": "boolean", "default": false },
56
91
  "locales": {
57
92
  "type": "object",
58
- "additionalProperties": { "$ref": "#/$defs/locale" }
93
+ "additionalProperties": {
94
+ "$ref": "#/$defs/locale"
95
+ }
96
+ },
97
+ "defaultLocale": {
98
+ "type": "string"
59
99
  },
60
- "defaultLocale": { "type": "string" },
61
100
  "content": {
62
101
  "type": "object",
63
102
  "additionalProperties": false,
64
103
  "properties": {
65
- "allowOutsideRoot": { "type": "boolean", "default": false },
66
- "localizeRepositoryLinks": { "type": "boolean", "default": false },
67
- "sources": { "type": "array", "items": { "$ref": "#/$defs/source" } }
104
+ "allowOutsideRoot": {
105
+ "type": "boolean",
106
+ "default": false
107
+ },
108
+ "localizeRepositoryLinks": {
109
+ "type": "boolean",
110
+ "default": false
111
+ },
112
+ "sources": {
113
+ "type": "array",
114
+ "items": {
115
+ "$ref": "#/$defs/source"
116
+ }
117
+ },
118
+ "frontmatter": {
119
+ "enum": ["preserve", "reject"],
120
+ "default": "preserve"
121
+ }
68
122
  }
69
123
  },
70
124
  "navigation": {
71
125
  "oneOf": [
72
126
  {
73
127
  "type": "array",
74
- "items": { "$ref": "#/$defs/navigationItem" }
128
+ "items": {
129
+ "$ref": "#/$defs/navigationItem"
130
+ }
75
131
  },
76
132
  {
77
133
  "type": "object",
@@ -79,11 +135,15 @@
79
135
  "properties": {
80
136
  "items": {
81
137
  "type": "array",
82
- "items": { "$ref": "#/$defs/navigationItem" }
138
+ "items": {
139
+ "$ref": "#/$defs/navigationItem"
140
+ }
83
141
  },
84
142
  "tabs": {
85
143
  "type": "array",
86
- "items": { "$ref": "#/$defs/navigationTab" }
144
+ "items": {
145
+ "$ref": "#/$defs/navigationTab"
146
+ }
87
147
  }
88
148
  }
89
149
  }
@@ -93,7 +153,6 @@
93
153
  "type": "object",
94
154
  "additionalProperties": false,
95
155
  "properties": {
96
- "variant": { "type": "string" },
97
156
  "brand": {},
98
157
  "palette": {
99
158
  "type": "object",
@@ -101,39 +160,308 @@
101
160
  "properties": {
102
161
  "surface": {},
103
162
  "text": {},
104
- "textSoft": {}
163
+ "textSoft": {},
164
+ "info": {},
165
+ "success": {},
166
+ "warning": {},
167
+ "danger": {}
105
168
  }
106
169
  },
107
170
  "states": {
108
171
  "type": "object",
109
- "additionalProperties": { "type": "string" }
172
+ "additionalProperties": {
173
+ "type": "string"
174
+ }
110
175
  },
111
176
  "tokens": {
112
177
  "type": "object",
113
- "propertyNames": { "pattern": "^(\\$|--)[a-zA-Z0-9_-]+$" },
114
- "additionalProperties": { "type": ["string", "number"] }
178
+ "propertyNames": {
179
+ "pattern": "^(\\$|--)[a-zA-Z0-9_-]+$"
180
+ },
181
+ "additionalProperties": {
182
+ "type": ["string", "number"]
183
+ }
115
184
  },
116
185
  "presets": {
117
186
  "type": "object",
118
- "additionalProperties": { "$ref": "#/$defs/typographyPreset" }
187
+ "additionalProperties": {
188
+ "$ref": "#/$defs/typographyPreset"
189
+ }
119
190
  },
120
191
  "styles": {
121
192
  "type": "object",
122
- "additionalProperties": {
123
- "type": "object",
124
- "propertyNames": { "not": { "const": "mode" } }
193
+ "additionalProperties": false,
194
+ "properties": {
195
+ "Card": {
196
+ "type": "object",
197
+ "propertyNames": {
198
+ "not": {
199
+ "const": "mode"
200
+ }
201
+ }
202
+ },
203
+ "Callout": {
204
+ "type": "object",
205
+ "propertyNames": {
206
+ "not": {
207
+ "const": "mode"
208
+ }
209
+ }
210
+ },
211
+ "CodeGroup": {
212
+ "type": "object",
213
+ "propertyNames": {
214
+ "not": {
215
+ "const": "mode"
216
+ }
217
+ }
218
+ },
219
+ "Tab": {
220
+ "type": "object",
221
+ "propertyNames": {
222
+ "not": {
223
+ "const": "mode"
224
+ }
225
+ }
226
+ },
227
+ "Footer": {
228
+ "type": "object",
229
+ "propertyNames": {
230
+ "not": {
231
+ "const": "mode"
232
+ }
233
+ }
234
+ },
235
+ "Hero": {
236
+ "type": "object",
237
+ "propertyNames": {
238
+ "not": {
239
+ "const": "mode"
240
+ }
241
+ }
242
+ },
243
+ "LanguageSelect": {
244
+ "type": "object",
245
+ "propertyNames": {
246
+ "not": {
247
+ "const": "mode"
248
+ }
249
+ }
250
+ },
251
+ "Logo": {
252
+ "type": "object",
253
+ "propertyNames": {
254
+ "not": {
255
+ "const": "mode"
256
+ }
257
+ }
258
+ },
259
+ "MarkdownCodeBlock": {
260
+ "type": "object",
261
+ "propertyNames": {
262
+ "not": {
263
+ "const": "mode"
264
+ }
265
+ }
266
+ },
267
+ "MarkdownHeading": {
268
+ "type": "object",
269
+ "propertyNames": {
270
+ "not": {
271
+ "const": "mode"
272
+ }
273
+ }
274
+ },
275
+ "MarkdownTable": {
276
+ "type": "object",
277
+ "propertyNames": {
278
+ "not": {
279
+ "const": "mode"
280
+ }
281
+ }
282
+ },
283
+ "Mermaid": {
284
+ "type": "object",
285
+ "propertyNames": {
286
+ "not": {
287
+ "const": "mode"
288
+ }
289
+ }
290
+ },
291
+ "MobileMenuFooter": {
292
+ "type": "object",
293
+ "propertyNames": {
294
+ "not": {
295
+ "const": "mode"
296
+ }
297
+ }
298
+ },
299
+ "MobileMenuToggle": {
300
+ "type": "object",
301
+ "propertyNames": {
302
+ "not": {
303
+ "const": "mode"
304
+ }
305
+ }
306
+ },
307
+ "MobileNavigationTabs": {
308
+ "type": "object",
309
+ "propertyNames": {
310
+ "not": {
311
+ "const": "mode"
312
+ }
313
+ }
314
+ },
315
+ "MobileTableOfContents": {
316
+ "type": "object",
317
+ "propertyNames": {
318
+ "not": {
319
+ "const": "mode"
320
+ }
321
+ }
322
+ },
323
+ "PackageVersion": {
324
+ "type": "object",
325
+ "propertyNames": {
326
+ "not": {
327
+ "const": "mode"
328
+ }
329
+ }
330
+ },
331
+ "Preview": {
332
+ "type": "object",
333
+ "propertyNames": {
334
+ "not": {
335
+ "const": "mode"
336
+ }
337
+ }
338
+ },
339
+ "Sidebar": {
340
+ "type": "object",
341
+ "propertyNames": {
342
+ "not": {
343
+ "const": "mode"
344
+ }
345
+ }
346
+ },
347
+ "Steps": {
348
+ "type": "object",
349
+ "propertyNames": {
350
+ "not": {
351
+ "const": "mode"
352
+ }
353
+ }
354
+ },
355
+ "Tabs": {
356
+ "type": "object",
357
+ "propertyNames": {
358
+ "not": {
359
+ "const": "mode"
360
+ }
361
+ }
362
+ },
363
+ "TableOfContents": {
364
+ "type": "object",
365
+ "propertyNames": {
366
+ "not": {
367
+ "const": "mode"
368
+ }
369
+ }
370
+ },
371
+ "ThemeSelect": {
372
+ "type": "object",
373
+ "propertyNames": {
374
+ "not": {
375
+ "const": "mode"
376
+ }
377
+ }
378
+ },
379
+ "TopNavigation": {
380
+ "type": "object",
381
+ "propertyNames": {
382
+ "not": {
383
+ "const": "mode"
384
+ }
385
+ }
386
+ },
387
+ "StarlightHeader": {
388
+ "type": "object",
389
+ "propertyNames": {
390
+ "not": {
391
+ "const": "mode"
392
+ }
393
+ }
394
+ },
395
+ "MarkdownInlineCode": {
396
+ "type": "object",
397
+ "propertyNames": {
398
+ "not": {
399
+ "const": "mode"
400
+ }
401
+ }
402
+ },
403
+ "SocialIcons": {
404
+ "type": "object",
405
+ "propertyNames": {
406
+ "not": {
407
+ "const": "mode"
408
+ }
409
+ }
410
+ }
125
411
  }
126
412
  },
127
413
  "contrastLevel": {
128
414
  "oneOf": [
129
- { "const": "auto" },
130
- { "type": "number", "minimum": 0, "maximum": 100 }
415
+ {
416
+ "const": "auto"
417
+ },
418
+ {
419
+ "type": "number",
420
+ "minimum": 0,
421
+ "maximum": 100
422
+ }
131
423
  ]
424
+ },
425
+ "customStyles": {
426
+ "type": "object",
427
+ "propertyNames": {
428
+ "pattern": "^[A-Za-z][A-Za-z0-9_-]*$"
429
+ },
430
+ "additionalProperties": {
431
+ "type": "object",
432
+ "propertyNames": {
433
+ "not": {
434
+ "const": "mode"
435
+ }
436
+ }
437
+ }
438
+ }
439
+ }
440
+ },
441
+ "markdown": {
442
+ "type": "object",
443
+ "additionalProperties": false,
444
+ "properties": {
445
+ "stripLeadingBadges": {
446
+ "type": "boolean",
447
+ "default": true
448
+ },
449
+ "rawHtml": {
450
+ "enum": ["allow", "sanitize", "strip", "reject"],
451
+ "default": "sanitize"
452
+ }
453
+ }
454
+ },
455
+ "search": {
456
+ "type": "object",
457
+ "additionalProperties": false,
458
+ "properties": {
459
+ "enabled": {
460
+ "type": "boolean",
461
+ "default": true
132
462
  }
133
463
  }
134
464
  },
135
- "markdown": { "type": "object" },
136
- "search": { "type": "object" },
137
465
  "components": {
138
466
  "type": "object",
139
467
  "additionalProperties": false,
@@ -142,14 +470,67 @@
142
470
  "type": "object",
143
471
  "properties": {
144
472
  "Footer": {
145
- "oneOf": [{ "type": "string" }, { "const": false }]
473
+ "oneOf": [
474
+ {
475
+ "type": "string"
476
+ },
477
+ {
478
+ "const": false
479
+ }
480
+ ]
146
481
  }
147
482
  },
148
- "additionalProperties": { "type": "string" }
483
+ "additionalProperties": {
484
+ "type": "string"
485
+ }
149
486
  }
150
487
  }
151
488
  },
152
- "build": { "type": "object" }
489
+ "build": {
490
+ "type": "object",
491
+ "additionalProperties": false,
492
+ "properties": {
493
+ "strict": {
494
+ "type": "boolean",
495
+ "default": true
496
+ },
497
+ "ci": {
498
+ "type": "boolean"
499
+ },
500
+ "cacheDir": {
501
+ "type": "string"
502
+ },
503
+ "maxArtifactBytes": {
504
+ "type": "integer",
505
+ "minimum": 1
506
+ },
507
+ "maxUnpackedBytes": {
508
+ "type": "integer",
509
+ "minimum": 1
510
+ },
511
+ "maxFiles": {
512
+ "type": "integer",
513
+ "minimum": 1
514
+ },
515
+ "maxPathDepth": {
516
+ "type": "integer",
517
+ "minimum": 1
518
+ },
519
+ "maxAssetBytes": {
520
+ "type": "integer",
521
+ "minimum": 1
522
+ }
523
+ }
524
+ },
525
+ "root": {
526
+ "type": "string"
527
+ },
528
+ "redirects": {
529
+ "type": "object",
530
+ "additionalProperties": {
531
+ "type": "string"
532
+ }
533
+ }
153
534
  },
154
535
  "$defs": {
155
536
  "locale": {
@@ -157,23 +538,35 @@
157
538
  "additionalProperties": false,
158
539
  "required": ["label"],
159
540
  "properties": {
160
- "label": { "type": "string" },
161
- "lang": { "type": "string" },
162
- "dir": { "enum": ["ltr", "rtl"] }
541
+ "label": {
542
+ "type": "string"
543
+ },
544
+ "lang": {
545
+ "type": "string"
546
+ },
547
+ "dir": {
548
+ "enum": ["ltr", "rtl"]
549
+ }
163
550
  }
164
551
  },
165
552
  "navigationItem": {
166
553
  "oneOf": [
167
- { "type": "string" },
554
+ {
555
+ "type": "string"
556
+ },
168
557
  {
169
558
  "type": "object",
170
559
  "additionalProperties": false,
171
560
  "required": ["label", "items"],
172
561
  "properties": {
173
- "label": { "type": "string" },
562
+ "label": {
563
+ "type": "string"
564
+ },
174
565
  "items": {
175
566
  "type": "array",
176
- "items": { "$ref": "#/$defs/navigationItem" }
567
+ "items": {
568
+ "$ref": "#/$defs/navigationItem"
569
+ }
177
570
  }
178
571
  }
179
572
  },
@@ -182,12 +575,18 @@
182
575
  "additionalProperties": false,
183
576
  "required": ["label", "autogenerate"],
184
577
  "properties": {
185
- "label": { "type": "string" },
578
+ "label": {
579
+ "type": "string"
580
+ },
186
581
  "autogenerate": {
187
582
  "type": "object",
188
583
  "additionalProperties": false,
189
584
  "required": ["directory"],
190
- "properties": { "directory": { "type": "string" } }
585
+ "properties": {
586
+ "directory": {
587
+ "type": "string"
588
+ }
589
+ }
191
590
  }
192
591
  }
193
592
  },
@@ -196,8 +595,12 @@
196
595
  "additionalProperties": false,
197
596
  "required": ["label", "link"],
198
597
  "properties": {
199
- "label": { "type": "string" },
200
- "link": { "type": "string" }
598
+ "label": {
599
+ "type": "string"
600
+ },
601
+ "link": {
602
+ "type": "string"
603
+ }
201
604
  }
202
605
  }
203
606
  ]
@@ -207,11 +610,17 @@
207
610
  "additionalProperties": false,
208
611
  "required": ["label", "link"],
209
612
  "properties": {
210
- "label": { "type": "string" },
211
- "link": { "type": "string" },
613
+ "label": {
614
+ "type": "string"
615
+ },
616
+ "link": {
617
+ "type": "string"
618
+ },
212
619
  "items": {
213
620
  "type": "array",
214
- "items": { "$ref": "#/$defs/navigationItem" }
621
+ "items": {
622
+ "$ref": "#/$defs/navigationItem"
623
+ }
215
624
  }
216
625
  }
217
626
  },
@@ -219,24 +628,175 @@
219
628
  "type": "object",
220
629
  "additionalProperties": false,
221
630
  "properties": {
222
- "fontFamily": { "type": "string" },
223
- "fontSize": { "type": ["string", "number"] },
224
- "lineHeight": { "type": ["string", "number"] },
225
- "letterSpacing": { "type": ["string", "number"] },
226
- "fontWeight": { "type": ["string", "number"] },
227
- "boldFontWeight": { "type": ["string", "number"] },
228
- "iconSize": { "type": ["string", "number"] },
229
- "textTransform": { "type": ["string", "number"] },
230
- "fontStyle": { "type": ["string", "number"] }
631
+ "fontFamily": {
632
+ "type": "string"
633
+ },
634
+ "fontSize": {
635
+ "type": ["string", "number"]
636
+ },
637
+ "lineHeight": {
638
+ "type": ["string", "number"]
639
+ },
640
+ "letterSpacing": {
641
+ "type": ["string", "number"]
642
+ },
643
+ "fontWeight": {
644
+ "type": ["string", "number"]
645
+ },
646
+ "boldFontWeight": {
647
+ "type": ["string", "number"]
648
+ },
649
+ "iconSize": {
650
+ "type": ["string", "number"]
651
+ },
652
+ "textTransform": {
653
+ "type": ["string", "number"]
654
+ },
655
+ "fontStyle": {
656
+ "type": ["string", "number"]
657
+ }
231
658
  }
232
659
  },
233
660
  "source": {
234
- "type": "object",
235
661
  "oneOf": [
236
- { "required": ["file"] },
237
- { "required": ["glob"] },
238
- { "required": ["package"] }
662
+ {
663
+ "type": "object",
664
+ "additionalProperties": false,
665
+ "required": ["file"],
666
+ "properties": {
667
+ "file": {
668
+ "type": "string",
669
+ "minLength": 1
670
+ },
671
+ "route": {
672
+ "type": "string"
673
+ },
674
+ "title": {
675
+ "type": "string"
676
+ },
677
+ "description": {
678
+ "type": "string"
679
+ },
680
+ "navigation": {
681
+ "oneOf": [
682
+ {
683
+ "const": false
684
+ },
685
+ {
686
+ "$ref": "#/$defs/navigationPlacement"
687
+ }
688
+ ]
689
+ },
690
+ "id": {
691
+ "type": "string",
692
+ "pattern": "^[a-zA-Z0-9_-]+$"
693
+ },
694
+ "routeBase": {
695
+ "type": "string"
696
+ },
697
+ "root": {
698
+ "type": "string"
699
+ }
700
+ }
701
+ },
702
+ {
703
+ "type": "object",
704
+ "additionalProperties": false,
705
+ "required": ["glob"],
706
+ "properties": {
707
+ "glob": {
708
+ "oneOf": [
709
+ {
710
+ "type": "string"
711
+ },
712
+ {
713
+ "type": "array",
714
+ "items": {
715
+ "type": "string"
716
+ }
717
+ }
718
+ ]
719
+ },
720
+ "base": {
721
+ "type": "string"
722
+ },
723
+ "routeBase": {
724
+ "type": "string"
725
+ },
726
+ "exclude": {
727
+ "type": "array",
728
+ "items": {
729
+ "type": "string"
730
+ }
731
+ },
732
+ "navigation": {
733
+ "enum": ["auto", false]
734
+ },
735
+ "id": {
736
+ "type": "string",
737
+ "pattern": "^[a-zA-Z0-9_-]+$"
738
+ },
739
+ "root": {
740
+ "type": "string"
741
+ }
742
+ }
743
+ },
744
+ {
745
+ "type": "object",
746
+ "additionalProperties": false,
747
+ "required": ["package"],
748
+ "properties": {
749
+ "package": {
750
+ "type": "string",
751
+ "minLength": 1
752
+ },
753
+ "include": {
754
+ "type": "array",
755
+ "items": {
756
+ "type": "string"
757
+ }
758
+ },
759
+ "exclude": {
760
+ "type": "array",
761
+ "items": {
762
+ "type": "string"
763
+ }
764
+ },
765
+ "index": {
766
+ "type": "string"
767
+ },
768
+ "routeBase": {
769
+ "type": "string"
770
+ },
771
+ "trust": {
772
+ "enum": ["markdown", "mdx"]
773
+ },
774
+ "id": {
775
+ "type": "string",
776
+ "pattern": "^[a-zA-Z0-9_-]+$"
777
+ },
778
+ "registry": {
779
+ "type": "string",
780
+ "format": "uri"
781
+ }
782
+ }
783
+ }
239
784
  ]
785
+ },
786
+ "navigationPlacement": {
787
+ "type": "object",
788
+ "additionalProperties": false,
789
+ "properties": {
790
+ "label": {
791
+ "type": "string"
792
+ },
793
+ "order": {
794
+ "type": "number"
795
+ },
796
+ "group": {
797
+ "type": "string"
798
+ }
799
+ }
240
800
  }
241
801
  }
242
802
  }