docs: update docusaurus to v3 (#5625)

* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "",
"optional": true,
"defaultValue": "",
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "T",
"type": "[`Stream`](../../internal/classes/internal.Stream.mdx)",
"type": "[Stream](../../internal/classes/internal.Stream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
@@ -88,7 +88,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ ___
},
{
"name": "error",
"type": "``null`` \\| [`Error`](../../modules/internal.mdx#error)",
"type": "``null`` \\| [Error](../../modules/internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ ___
},
{
"name": "callback",
"type": "(`error`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "defaultEncoding",
"type": "[`BufferEncoding`](../../internal/types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../../internal/types/internal.BufferEncoding.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "signal",
"type": "`AbortSignal`",
"type": "AbortSignal",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
@@ -83,7 +83,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/internal.internal-3.Writable.mdx)",
"type": "[Writable](../classes/internal.internal-3.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -92,7 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -124,7 +124,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/internal.internal-3.Writable.mdx)",
"type": "[Writable](../classes/internal.internal-3.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -133,7 +133,7 @@ ___
},
{
"name": "error",
"type": "``null`` \\| [`Error`](../../modules/internal.mdx#error)",
"type": "``null`` \\| [Error](../../modules/internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -142,7 +142,7 @@ ___
},
{
"name": "callback",
"type": "(`error`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/internal.internal-3.Writable.mdx)",
"type": "[Writable](../classes/internal.internal-3.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ ___
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -215,7 +215,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/internal.internal-3.Writable.mdx)",
"type": "[Writable](../classes/internal.internal-3.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -233,7 +233,7 @@ ___
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../../internal/types/internal.BufferEncoding.mdx)",
"type": "[BufferEncoding](../../internal/types/internal.BufferEncoding.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -242,7 +242,7 @@ ___
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -274,7 +274,7 @@ ___
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/internal.internal-3.Writable.mdx)",
"type": "[Writable](../classes/internal.internal-3.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ ___
},
{
"name": "chunks",
"type": "{ `chunk`: `any` ; `encoding`: [`BufferEncoding`](../../internal/types/internal.BufferEncoding.mdx) }[]",
"type": "`&#123; chunk: any ; encoding: [BufferEncoding](../../internal/types/internal.BufferEncoding.mdx) &#125;`[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ ___
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../modules/internal.mdx#error)) => `void`",
"type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",