@teambit/docs 1.0.310 → 1.0.311
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.
- package/artifacts/__bit_junit.xml +1 -1
- package/artifacts/preview/static/css/teambit.docs/{docs-preview.de577cfb.css → docs-preview.38749382.css} +6 -6
- package/artifacts/preview/teambit_docs_docs-preview.js +6 -6
- package/artifacts/schema.json +49 -24
- package/dist/default-doc-reader.d.ts +0 -1
- package/dist/doc-reader.d.ts +0 -1
- package/dist/{preview-1718853656395.js → preview-1719137078208.js} +2 -2
- package/package.json +17 -17
package/artifacts/schema.json
CHANGED
|
@@ -105,7 +105,8 @@
|
|
|
105
105
|
"character": 1
|
|
106
106
|
},
|
|
107
107
|
"raw": "/**\n * the component documentation extension.\n */",
|
|
108
|
-
"comment": "the component documentation extension."
|
|
108
|
+
"comment": "the component documentation extension.",
|
|
109
|
+
"tags": []
|
|
109
110
|
},
|
|
110
111
|
"signature": "class DocsMain",
|
|
111
112
|
"name": "DocsMain",
|
|
@@ -385,7 +386,8 @@
|
|
|
385
386
|
"character": 3
|
|
386
387
|
},
|
|
387
388
|
"raw": "/**\n * returns an array of doc file paths for a set of components.\n */",
|
|
388
|
-
"comment": "returns an array of doc file paths for a set of components."
|
|
389
|
+
"comment": "returns an array of doc file paths for a set of components.",
|
|
390
|
+
"tags": []
|
|
389
391
|
},
|
|
390
392
|
"signature": "(method) DocsMain.getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]>",
|
|
391
393
|
"name": "getDocsMap",
|
|
@@ -528,7 +530,8 @@
|
|
|
528
530
|
"character": 3
|
|
529
531
|
},
|
|
530
532
|
"raw": "/**\n * compute the description of the component from its source code and docs file.\n */",
|
|
531
|
-
"comment": "compute the description of the component from its source code and docs file."
|
|
533
|
+
"comment": "compute the description of the component from its source code and docs file.",
|
|
534
|
+
"tags": []
|
|
532
535
|
},
|
|
533
536
|
"signature": "(method) DocsMain.getDescription(component: Component): Promise<string>",
|
|
534
537
|
"name": "getDescription",
|
|
@@ -717,7 +720,8 @@
|
|
|
717
720
|
"character": 3
|
|
718
721
|
},
|
|
719
722
|
"raw": "/**\n * compute a doc for a component.\n */",
|
|
720
|
-
"comment": "compute a doc for a component."
|
|
723
|
+
"comment": "compute a doc for a component.",
|
|
724
|
+
"tags": []
|
|
721
725
|
},
|
|
722
726
|
"signature": "(method) DocsMain.computeDoc(component: Component): Promise<Doc | null>",
|
|
723
727
|
"name": "computeDoc",
|
|
@@ -909,7 +913,8 @@
|
|
|
909
913
|
"character": 3
|
|
910
914
|
},
|
|
911
915
|
"raw": "/**\n * register a new doc reader. this allows to support further\n * documentation file formats.\n */",
|
|
912
|
-
"comment": "register a new doc reader. this allows to support further\ndocumentation file formats."
|
|
916
|
+
"comment": "register a new doc reader. this allows to support further\ndocumentation file formats.",
|
|
917
|
+
"tags": []
|
|
913
918
|
},
|
|
914
919
|
"signature": "(method) DocsMain.registerDocReader(docReader: DocReader): this",
|
|
915
920
|
"name": "registerDocReader",
|
|
@@ -1355,7 +1360,8 @@
|
|
|
1355
1360
|
"character": 3
|
|
1356
1361
|
},
|
|
1357
1362
|
"raw": "/**\n * register a new title badge into the overview section of a component.\n */",
|
|
1358
|
-
"comment": "register a new title badge into the overview section of a component."
|
|
1363
|
+
"comment": "register a new title badge into the overview section of a component.",
|
|
1364
|
+
"tags": []
|
|
1359
1365
|
},
|
|
1360
1366
|
"signature": "(method) DocsUI.registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]): this",
|
|
1361
1367
|
"name": "registerTitleBadge",
|
|
@@ -1434,7 +1440,8 @@
|
|
|
1434
1440
|
"character": 3
|
|
1435
1441
|
},
|
|
1436
1442
|
"raw": "/**\n * list all title badges registered.\n */",
|
|
1437
|
-
"comment": "list all title badges registered."
|
|
1443
|
+
"comment": "list all title badges registered.",
|
|
1444
|
+
"tags": []
|
|
1438
1445
|
},
|
|
1439
1446
|
"signature": "(method) DocsUI.listTitleBadges(): TitleBadge[]",
|
|
1440
1447
|
"name": "listTitleBadges",
|
|
@@ -2384,7 +2391,8 @@
|
|
|
2384
2391
|
"character": 3
|
|
2385
2392
|
},
|
|
2386
2393
|
"raw": "/**\n * determine which file formats are supported by the doc reader.\n */",
|
|
2387
|
-
"comment": "determine which file formats are supported by the doc reader."
|
|
2394
|
+
"comment": "determine which file formats are supported by the doc reader.",
|
|
2395
|
+
"tags": []
|
|
2388
2396
|
},
|
|
2389
2397
|
"signature": "(method) DocReader.isFormatSupported(ext: string): boolean",
|
|
2390
2398
|
"name": "isFormatSupported",
|
|
@@ -2465,7 +2473,8 @@
|
|
|
2465
2473
|
"character": 3
|
|
2466
2474
|
},
|
|
2467
2475
|
"raw": "/**\n * default is the docs content.\n */",
|
|
2468
|
-
"comment": "default is the docs content."
|
|
2476
|
+
"comment": "default is the docs content.",
|
|
2477
|
+
"tags": []
|
|
2469
2478
|
},
|
|
2470
2479
|
"signature": "(property) default: React.ComponentType<{}>",
|
|
2471
2480
|
"name": "default",
|
|
@@ -2495,7 +2504,8 @@
|
|
|
2495
2504
|
"character": 3
|
|
2496
2505
|
},
|
|
2497
2506
|
"raw": "/**\n * component abstract.\n */",
|
|
2498
|
-
"comment": "component abstract."
|
|
2507
|
+
"comment": "component abstract.",
|
|
2508
|
+
"tags": []
|
|
2499
2509
|
},
|
|
2500
2510
|
"signature": "(property) abstract: string",
|
|
2501
2511
|
"name": "abstract",
|
|
@@ -2525,7 +2535,8 @@
|
|
|
2525
2535
|
"character": 3
|
|
2526
2536
|
},
|
|
2527
2537
|
"raw": "/**\n * array of labels.\n */",
|
|
2528
|
-
"comment": "array of labels."
|
|
2538
|
+
"comment": "array of labels.",
|
|
2539
|
+
"tags": []
|
|
2529
2540
|
},
|
|
2530
2541
|
"signature": "(property) labels: string[]",
|
|
2531
2542
|
"name": "labels",
|
|
@@ -2563,6 +2574,7 @@
|
|
|
2563
2574
|
"character": 3
|
|
2564
2575
|
},
|
|
2565
2576
|
"raw": "/**\n * @deprecated\n */",
|
|
2577
|
+
"comment": "",
|
|
2566
2578
|
"tags": [
|
|
2567
2579
|
{
|
|
2568
2580
|
"__schema": "TagSchema",
|
|
@@ -3477,7 +3489,8 @@
|
|
|
3477
3489
|
"character": 3
|
|
3478
3490
|
},
|
|
3479
3491
|
"raw": "/**\n * glob patterns to identify doc files.\n */",
|
|
3480
|
-
"comment": "glob patterns to identify doc files."
|
|
3492
|
+
"comment": "glob patterns to identify doc files.",
|
|
3493
|
+
"tags": []
|
|
3481
3494
|
},
|
|
3482
3495
|
"signature": "(property) patterns: string[]",
|
|
3483
3496
|
"name": "patterns",
|
|
@@ -3518,7 +3531,8 @@
|
|
|
3518
3531
|
"character": 1
|
|
3519
3532
|
},
|
|
3520
3533
|
"raw": "/**\n * the component documentation extension.\n */",
|
|
3521
|
-
"comment": "the component documentation extension."
|
|
3534
|
+
"comment": "the component documentation extension.",
|
|
3535
|
+
"tags": []
|
|
3522
3536
|
},
|
|
3523
3537
|
"signature": "class DocsMain",
|
|
3524
3538
|
"name": "DocsMain",
|
|
@@ -3798,7 +3812,8 @@
|
|
|
3798
3812
|
"character": 3
|
|
3799
3813
|
},
|
|
3800
3814
|
"raw": "/**\n * returns an array of doc file paths for a set of components.\n */",
|
|
3801
|
-
"comment": "returns an array of doc file paths for a set of components."
|
|
3815
|
+
"comment": "returns an array of doc file paths for a set of components.",
|
|
3816
|
+
"tags": []
|
|
3802
3817
|
},
|
|
3803
3818
|
"signature": "(method) DocsMain.getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]>",
|
|
3804
3819
|
"name": "getDocsMap",
|
|
@@ -3941,7 +3956,8 @@
|
|
|
3941
3956
|
"character": 3
|
|
3942
3957
|
},
|
|
3943
3958
|
"raw": "/**\n * compute the description of the component from its source code and docs file.\n */",
|
|
3944
|
-
"comment": "compute the description of the component from its source code and docs file."
|
|
3959
|
+
"comment": "compute the description of the component from its source code and docs file.",
|
|
3960
|
+
"tags": []
|
|
3945
3961
|
},
|
|
3946
3962
|
"signature": "(method) DocsMain.getDescription(component: Component): Promise<string>",
|
|
3947
3963
|
"name": "getDescription",
|
|
@@ -4130,7 +4146,8 @@
|
|
|
4130
4146
|
"character": 3
|
|
4131
4147
|
},
|
|
4132
4148
|
"raw": "/**\n * compute a doc for a component.\n */",
|
|
4133
|
-
"comment": "compute a doc for a component."
|
|
4149
|
+
"comment": "compute a doc for a component.",
|
|
4150
|
+
"tags": []
|
|
4134
4151
|
},
|
|
4135
4152
|
"signature": "(method) DocsMain.computeDoc(component: Component): Promise<Doc | null>",
|
|
4136
4153
|
"name": "computeDoc",
|
|
@@ -4322,7 +4339,8 @@
|
|
|
4322
4339
|
"character": 3
|
|
4323
4340
|
},
|
|
4324
4341
|
"raw": "/**\n * register a new doc reader. this allows to support further\n * documentation file formats.\n */",
|
|
4325
|
-
"comment": "register a new doc reader. this allows to support further\ndocumentation file formats."
|
|
4342
|
+
"comment": "register a new doc reader. this allows to support further\ndocumentation file formats.",
|
|
4343
|
+
"tags": []
|
|
4326
4344
|
},
|
|
4327
4345
|
"signature": "(method) DocsMain.registerDocReader(docReader: DocReader): this",
|
|
4328
4346
|
"name": "registerDocReader",
|
|
@@ -4781,7 +4799,8 @@
|
|
|
4781
4799
|
"character": 3
|
|
4782
4800
|
},
|
|
4783
4801
|
"raw": "/**\n * register a new title badge into the overview section of a component.\n */",
|
|
4784
|
-
"comment": "register a new title badge into the overview section of a component."
|
|
4802
|
+
"comment": "register a new title badge into the overview section of a component.",
|
|
4803
|
+
"tags": []
|
|
4785
4804
|
},
|
|
4786
4805
|
"signature": "(method) DocsUI.registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]): this",
|
|
4787
4806
|
"name": "registerTitleBadge",
|
|
@@ -4860,7 +4879,8 @@
|
|
|
4860
4879
|
"character": 3
|
|
4861
4880
|
},
|
|
4862
4881
|
"raw": "/**\n * list all title badges registered.\n */",
|
|
4863
|
-
"comment": "list all title badges registered."
|
|
4882
|
+
"comment": "list all title badges registered.",
|
|
4883
|
+
"tags": []
|
|
4864
4884
|
},
|
|
4865
4885
|
"signature": "(method) DocsUI.listTitleBadges(): TitleBadge[]",
|
|
4866
4886
|
"name": "listTitleBadges",
|
|
@@ -5923,7 +5943,8 @@
|
|
|
5923
5943
|
"character": 3
|
|
5924
5944
|
},
|
|
5925
5945
|
"raw": "/**\n * determine which file formats are supported by the doc reader.\n */",
|
|
5926
|
-
"comment": "determine which file formats are supported by the doc reader."
|
|
5946
|
+
"comment": "determine which file formats are supported by the doc reader.",
|
|
5947
|
+
"tags": []
|
|
5927
5948
|
},
|
|
5928
5949
|
"signature": "(method) DocReader.isFormatSupported(ext: string): boolean",
|
|
5929
5950
|
"name": "isFormatSupported",
|
|
@@ -6165,7 +6186,8 @@
|
|
|
6165
6186
|
"character": 3
|
|
6166
6187
|
},
|
|
6167
6188
|
"raw": "/**\n * default is the docs content.\n */",
|
|
6168
|
-
"comment": "default is the docs content."
|
|
6189
|
+
"comment": "default is the docs content.",
|
|
6190
|
+
"tags": []
|
|
6169
6191
|
},
|
|
6170
6192
|
"signature": "(property) default: React.ComponentType<{}>",
|
|
6171
6193
|
"name": "default",
|
|
@@ -6195,7 +6217,8 @@
|
|
|
6195
6217
|
"character": 3
|
|
6196
6218
|
},
|
|
6197
6219
|
"raw": "/**\n * component abstract.\n */",
|
|
6198
|
-
"comment": "component abstract."
|
|
6220
|
+
"comment": "component abstract.",
|
|
6221
|
+
"tags": []
|
|
6199
6222
|
},
|
|
6200
6223
|
"signature": "(property) abstract: string",
|
|
6201
6224
|
"name": "abstract",
|
|
@@ -6225,7 +6248,8 @@
|
|
|
6225
6248
|
"character": 3
|
|
6226
6249
|
},
|
|
6227
6250
|
"raw": "/**\n * array of labels.\n */",
|
|
6228
|
-
"comment": "array of labels."
|
|
6251
|
+
"comment": "array of labels.",
|
|
6252
|
+
"tags": []
|
|
6229
6253
|
},
|
|
6230
6254
|
"signature": "(property) labels: string[]",
|
|
6231
6255
|
"name": "labels",
|
|
@@ -6263,6 +6287,7 @@
|
|
|
6263
6287
|
"character": 3
|
|
6264
6288
|
},
|
|
6265
6289
|
"raw": "/**\n * @deprecated\n */",
|
|
6290
|
+
"comment": "",
|
|
6266
6291
|
"tags": [
|
|
6267
6292
|
{
|
|
6268
6293
|
"__schema": "TagSchema",
|
|
@@ -6960,7 +6985,7 @@
|
|
|
6960
6985
|
"componentId": {
|
|
6961
6986
|
"scope": "teambit.docs",
|
|
6962
6987
|
"name": "docs",
|
|
6963
|
-
"version": "1.0.
|
|
6988
|
+
"version": "1.0.311"
|
|
6964
6989
|
},
|
|
6965
6990
|
"taggedModuleExports": []
|
|
6966
6991
|
}
|
package/dist/doc-reader.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.docs_docs@1.0.
|
|
2
|
-
import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.docs_docs@1.0.
|
|
1
|
+
import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.docs_docs@1.0.311/dist/docs.composition.js';
|
|
2
|
+
import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.docs_docs@1.0.311/dist/docs.docs.mdx';
|
|
3
3
|
|
|
4
4
|
export const compositions = [compositions_0];
|
|
5
5
|
export const overview = [overview_0];
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@teambit/docs",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.311",
|
|
4
4
|
"homepage": "https://bit.cloud/teambit/docs/docs",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"componentId": {
|
|
7
7
|
"scope": "teambit.docs",
|
|
8
8
|
"name": "docs",
|
|
9
|
-
"version": "1.0.
|
|
9
|
+
"version": "1.0.311"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"graphql-tag": "2.12.1",
|
|
@@ -19,21 +19,21 @@
|
|
|
19
19
|
"@teambit/base-react.themes.theme-switcher": "1.0.2",
|
|
20
20
|
"@teambit/component.ui.component-meta": "0.0.358",
|
|
21
21
|
"@teambit/base-ui.loaders.skeleton": "1.0.1",
|
|
22
|
-
"@teambit/compiler": "1.0.
|
|
23
|
-
"@teambit/component": "1.0.
|
|
24
|
-
"@teambit/pkg": "1.0.
|
|
25
|
-
"@teambit/workspace": "1.0.
|
|
26
|
-
"@teambit/cli": "0.0.
|
|
27
|
-
"@teambit/dev-files": "1.0.
|
|
28
|
-
"@teambit/envs": "1.0.
|
|
29
|
-
"@teambit/graphql": "1.0.
|
|
30
|
-
"@teambit/logger": "0.0.
|
|
31
|
-
"@teambit/preview": "1.0.
|
|
32
|
-
"@teambit/scope": "1.0.
|
|
33
|
-
"@teambit/api-reference": "1.0.
|
|
34
|
-
"@teambit/component-compare": "1.0.
|
|
35
|
-
"@teambit/ui": "1.0.
|
|
36
|
-
"@teambit/pubsub": "1.0.
|
|
22
|
+
"@teambit/compiler": "1.0.311",
|
|
23
|
+
"@teambit/component": "1.0.311",
|
|
24
|
+
"@teambit/pkg": "1.0.311",
|
|
25
|
+
"@teambit/workspace": "1.0.311",
|
|
26
|
+
"@teambit/cli": "0.0.888",
|
|
27
|
+
"@teambit/dev-files": "1.0.311",
|
|
28
|
+
"@teambit/envs": "1.0.311",
|
|
29
|
+
"@teambit/graphql": "1.0.311",
|
|
30
|
+
"@teambit/logger": "0.0.981",
|
|
31
|
+
"@teambit/preview": "1.0.311",
|
|
32
|
+
"@teambit/scope": "1.0.311",
|
|
33
|
+
"@teambit/api-reference": "1.0.311",
|
|
34
|
+
"@teambit/component-compare": "1.0.311",
|
|
35
|
+
"@teambit/ui": "1.0.311",
|
|
36
|
+
"@teambit/pubsub": "1.0.311",
|
|
37
37
|
"@teambit/compositions.panels.composition-gallery": "0.0.211",
|
|
38
38
|
"@teambit/preview.ui.component-preview": "1.0.12"
|
|
39
39
|
},
|