@teambit/docs 1.0.310 → 1.0.312

package/artifacts/schema.json

@@ -105,7 +105,8 @@
               "character": 1
             },
             "raw": "/**\n * the component documentation extension.\n */",
-            "comment": "the component documentation extension."
+            "comment": "the component documentation extension.",
+            "tags": []
           },
           "signature": "class DocsMain",
           "name": "DocsMain",
@@ -385,7 +386,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * returns an array of doc file paths for a set of components.\n   */",
-                "comment": "returns an array of doc file paths for a set of components."
+                "comment": "returns an array of doc file paths for a set of components.",
+                "tags": []
               },
               "signature": "(method) DocsMain.getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]>",
               "name": "getDocsMap",
@@ -528,7 +530,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * compute the description of the component from its source code and docs file.\n   */",
-                "comment": "compute the description of the component from its source code and docs file."
+                "comment": "compute the description of the component from its source code and docs file.",
+                "tags": []
               },
               "signature": "(method) DocsMain.getDescription(component: Component): Promise<string>",
               "name": "getDescription",
@@ -717,7 +720,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * compute a doc for a component.\n   */",
-                "comment": "compute a doc for a component."
+                "comment": "compute a doc for a component.",
+                "tags": []
               },
               "signature": "(method) DocsMain.computeDoc(component: Component): Promise<Doc | null>",
               "name": "computeDoc",
@@ -909,7 +913,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * register a new doc reader. this allows to support further\n   * documentation file formats.\n   */",
-                "comment": "register a new doc reader. this allows to support further\ndocumentation file formats."
+                "comment": "register a new doc reader. this allows to support further\ndocumentation file formats.",
+                "tags": []
               },
               "signature": "(method) DocsMain.registerDocReader(docReader: DocReader): this",
               "name": "registerDocReader",
@@ -1355,7 +1360,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * register a new title badge into the overview section of a component.\n   */",
-                "comment": "register a new title badge into the overview section of a component."
+                "comment": "register a new title badge into the overview section of a component.",
+                "tags": []
               },
               "signature": "(method) DocsUI.registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]): this",
               "name": "registerTitleBadge",
@@ -1434,7 +1440,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * list all title badges registered.\n   */",
-                "comment": "list all title badges registered."
+                "comment": "list all title badges registered.",
+                "tags": []
               },
               "signature": "(method) DocsUI.listTitleBadges(): TitleBadge[]",
               "name": "listTitleBadges",
@@ -2384,7 +2391,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * determine which file formats are supported by the doc reader.\n   */",
-                "comment": "determine which file formats are supported by the doc reader."
+                "comment": "determine which file formats are supported by the doc reader.",
+                "tags": []
               },
               "signature": "(method) DocReader.isFormatSupported(ext: string): boolean",
               "name": "isFormatSupported",
@@ -2465,7 +2473,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * default is the docs content.\n   */",
-                  "comment": "default is the docs content."
+                  "comment": "default is the docs content.",
+                  "tags": []
                 },
                 "signature": "(property) default: React.ComponentType<{}>",
                 "name": "default",
@@ -2495,7 +2504,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * component abstract.\n   */",
-                  "comment": "component abstract."
+                  "comment": "component abstract.",
+                  "tags": []
                 },
                 "signature": "(property) abstract: string",
                 "name": "abstract",
@@ -2525,7 +2535,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * array of labels.\n   */",
-                  "comment": "array of labels."
+                  "comment": "array of labels.",
+                  "tags": []
                 },
                 "signature": "(property) labels: string[]",
                 "name": "labels",
@@ -2563,6 +2574,7 @@
                     "character": 3
                   },
                   "raw": "/**\n   * @deprecated\n   */",
+                  "comment": "",
                   "tags": [
                     {
                       "__schema": "TagSchema",
@@ -3477,7 +3489,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * glob patterns to identify doc files.\n   */",
-                  "comment": "glob patterns to identify doc files."
+                  "comment": "glob patterns to identify doc files.",
+                  "tags": []
                 },
                 "signature": "(property) patterns: string[]",
                 "name": "patterns",
@@ -3518,7 +3531,8 @@
               "character": 1
             },
             "raw": "/**\n * the component documentation extension.\n */",
-            "comment": "the component documentation extension."
+            "comment": "the component documentation extension.",
+            "tags": []
           },
           "signature": "class DocsMain",
           "name": "DocsMain",
@@ -3798,7 +3812,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * returns an array of doc file paths for a set of components.\n   */",
-                "comment": "returns an array of doc file paths for a set of components."
+                "comment": "returns an array of doc file paths for a set of components.",
+                "tags": []
               },
               "signature": "(method) DocsMain.getDocsMap(components: Component[]): ComponentMap<AbstractVinyl[]>",
               "name": "getDocsMap",
@@ -3941,7 +3956,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * compute the description of the component from its source code and docs file.\n   */",
-                "comment": "compute the description of the component from its source code and docs file."
+                "comment": "compute the description of the component from its source code and docs file.",
+                "tags": []
               },
               "signature": "(method) DocsMain.getDescription(component: Component): Promise<string>",
               "name": "getDescription",
@@ -4130,7 +4146,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * compute a doc for a component.\n   */",
-                "comment": "compute a doc for a component."
+                "comment": "compute a doc for a component.",
+                "tags": []
               },
               "signature": "(method) DocsMain.computeDoc(component: Component): Promise<Doc | null>",
               "name": "computeDoc",
@@ -4322,7 +4339,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * register a new doc reader. this allows to support further\n   * documentation file formats.\n   */",
-                "comment": "register a new doc reader. this allows to support further\ndocumentation file formats."
+                "comment": "register a new doc reader. this allows to support further\ndocumentation file formats.",
+                "tags": []
               },
               "signature": "(method) DocsMain.registerDocReader(docReader: DocReader): this",
               "name": "registerDocReader",
@@ -4781,7 +4799,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * register a new title badge into the overview section of a component.\n   */",
-                "comment": "register a new title badge into the overview section of a component."
+                "comment": "register a new title badge into the overview section of a component.",
+                "tags": []
               },
               "signature": "(method) DocsUI.registerTitleBadge(titleBadges: TitleBadge | TitleBadge[]): this",
               "name": "registerTitleBadge",
@@ -4860,7 +4879,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * list all title badges registered.\n   */",
-                "comment": "list all title badges registered."
+                "comment": "list all title badges registered.",
+                "tags": []
               },
               "signature": "(method) DocsUI.listTitleBadges(): TitleBadge[]",
               "name": "listTitleBadges",
@@ -5923,7 +5943,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * determine which file formats are supported by the doc reader.\n   */",
-                "comment": "determine which file formats are supported by the doc reader."
+                "comment": "determine which file formats are supported by the doc reader.",
+                "tags": []
               },
               "signature": "(method) DocReader.isFormatSupported(ext: string): boolean",
               "name": "isFormatSupported",
@@ -6165,7 +6186,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * default is the docs content.\n   */",
-                  "comment": "default is the docs content."
+                  "comment": "default is the docs content.",
+                  "tags": []
                 },
                 "signature": "(property) default: React.ComponentType<{}>",
                 "name": "default",
@@ -6195,7 +6217,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * component abstract.\n   */",
-                  "comment": "component abstract."
+                  "comment": "component abstract.",
+                  "tags": []
                 },
                 "signature": "(property) abstract: string",
                 "name": "abstract",
@@ -6225,7 +6248,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * array of labels.\n   */",
-                  "comment": "array of labels."
+                  "comment": "array of labels.",
+                  "tags": []
                 },
                 "signature": "(property) labels: string[]",
                 "name": "labels",
@@ -6263,6 +6287,7 @@
                     "character": 3
                   },
                   "raw": "/**\n   * @deprecated\n   */",
+                  "comment": "",
                   "tags": [
                     {
                       "__schema": "TagSchema",
@@ -6960,7 +6985,7 @@
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.310"
+    "version": "1.0.312"
   },
   "taggedModuleExports": []
 }

package/dist/default-doc-reader.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { PkgMain } from '@teambit/pkg';
 import type { Component } from '@teambit/component';
 import type { CompilerMain } from '@teambit/compiler';

package/dist/doc-reader.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { Component } from '@teambit/component';
 import { Doc } from '@teambit/docs.entities.doc';
 export interface DocReader {

package/dist/{preview-1718853656395.js → preview-1719154175406.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.docs_docs@1.0.310/dist/docs.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.docs_docs@1.0.310/dist/docs.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.docs_docs@1.0.312/dist/docs.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.docs_docs@1.0.312/dist/docs.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/docs",
-  "version": "1.0.310",
+  "version": "1.0.312",
   "homepage": "https://bit.cloud/teambit/docs/docs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.docs",
     "name": "docs",
-    "version": "1.0.310"
+    "version": "1.0.312"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -19,21 +19,21 @@
     "@teambit/base-react.themes.theme-switcher": "1.0.2",
     "@teambit/component.ui.component-meta": "0.0.358",
     "@teambit/base-ui.loaders.skeleton": "1.0.1",
-    "@teambit/compiler": "1.0.310",
-    "@teambit/component": "1.0.310",
-    "@teambit/pkg": "1.0.310",
-    "@teambit/workspace": "1.0.310",
-    "@teambit/cli": "0.0.887",
-    "@teambit/dev-files": "1.0.310",
-    "@teambit/envs": "1.0.310",
-    "@teambit/graphql": "1.0.310",
-    "@teambit/logger": "0.0.980",
-    "@teambit/preview": "1.0.310",
-    "@teambit/scope": "1.0.310",
-    "@teambit/api-reference": "1.0.310",
-    "@teambit/component-compare": "1.0.310",
-    "@teambit/ui": "1.0.310",
-    "@teambit/pubsub": "1.0.310",
+    "@teambit/compiler": "1.0.312",
+    "@teambit/component": "1.0.312",
+    "@teambit/pkg": "1.0.312",
+    "@teambit/workspace": "1.0.312",
+    "@teambit/cli": "0.0.889",
+    "@teambit/dev-files": "1.0.312",
+    "@teambit/envs": "1.0.312",
+    "@teambit/graphql": "1.0.312",
+    "@teambit/logger": "0.0.982",
+    "@teambit/preview": "1.0.312",
+    "@teambit/scope": "1.0.312",
+    "@teambit/api-reference": "1.0.312",
+    "@teambit/component-compare": "1.0.312",
+    "@teambit/ui": "1.0.312",
+    "@teambit/pubsub": "1.0.312",
     "@teambit/compositions.panels.composition-gallery": "0.0.211",
     "@teambit/preview.ui.component-preview": "1.0.12"
   },