asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update docusaurus to v3 (#5625)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

6
www/apps/docs/content/references/js-client/internal-3/modules/internal.internal-3.finished.mdx
View File

@@ -15,7 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../../internal/interfaces/internal.ReadableStream-1.mdx) \\| [`WritableStream`](../../internal/interfaces/internal.WritableStream.mdx) \\| [`ReadWriteStream`](../../internal/interfaces/internal.ReadWriteStream.mdx)",
"type": "[ReadableStream](../../internal/interfaces/internal.ReadableStream-1.mdx) \\| [WritableStream](../../internal/interfaces/internal.WritableStream.mdx) \\| [ReadWriteStream](../../internal/interfaces/internal.ReadWriteStream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "[`FinishedOptions`](../interfaces/internal.internal-3.FinishedOptions.mdx)",
"type": "[FinishedOptions](../interfaces/internal.internal-3.FinishedOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",

48
www/apps/docs/content/references/js-client/internal-3/modules/internal.internal-3.pipeline.mdx
View File

@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### \_\_promisify\_\_
**__promisify__**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\>
`**__promisify__**<TypeParameter A, TypeParameter B>(source, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;`
#### Parameters
@@ -35,7 +35,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "[`PipelineOptions`](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"type": "[PipelineOptions](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\\>",
"type": "[PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
**__promisify__**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\>
`**__promisify__**<TypeParameter A, TypeParameter T1, TypeParameter B>(source, transform1, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;`
#### Parameters
@@ -92,7 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "[`PipelineOptions`](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"type": "[PipelineOptions](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -106,7 +106,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\\>",
"type": "[PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -115,7 +115,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
**__promisify__**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\>
`**__promisify__**<TypeParameter A, TypeParameter T1, TypeParameter T2, TypeParameter B>(source, transform1, transform2, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;`
#### Parameters
@@ -158,7 +158,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "[`PipelineOptions`](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"type": "[PipelineOptions](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -172,7 +172,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\\>",
"type": "[PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -181,7 +181,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
**__promisify__**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\>
`**__promisify__**<TypeParameter A, TypeParameter T1, TypeParameter T2, TypeParameter T3, TypeParameter B>(source, transform1, transform2, transform3, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;`
#### Parameters
@@ -233,7 +233,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "[`PipelineOptions`](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"type": "[PipelineOptions](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -247,7 +247,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\\>",
"type": "[PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -256,7 +256,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
**__promisify__**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\>
`**__promisify__**<TypeParameter A, TypeParameter T1, TypeParameter T2, TypeParameter T3, TypeParameter T4, TypeParameter B>(source, transform1, transform2, transform3, transform4, destination, options?): [PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;`
#### Parameters
@@ -317,7 +317,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "[`PipelineOptions`](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"type": "[PipelineOptions](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -331,7 +331,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../types/internal.internal-3.PipelinePromise.mdx)<`B`\\>",
"type": "[PipelinePromise](../types/internal.internal-3.PipelinePromise.mdx)&#60;B&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -340,14 +340,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
**__promisify__**(`streams`, `options?`): `Promise`<`void`\>
`**__promisify__**(streams, options?): Promise&#60;void&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "streams",
"type": "readonly ([`ReadableStream`](../../internal/interfaces/internal.ReadableStream-1.mdx) \\| [`WritableStream`](../../internal/interfaces/internal.WritableStream.mdx) \\| [`ReadWriteStream`](../../internal/interfaces/internal.ReadWriteStream.mdx))[]",
"type": "readonly ([ReadableStream](../../internal/interfaces/internal.ReadableStream-1.mdx) \\| [WritableStream](../../internal/interfaces/internal.WritableStream.mdx) \\| [ReadWriteStream](../../internal/interfaces/internal.ReadWriteStream.mdx))[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options",
"type": "[`PipelineOptions`](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"type": "[PipelineOptions](../interfaces/internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -370,7 +370,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -379,14 +379,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
**__promisify__**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\>
`**__promisify__**(stream1, stream2, ...streams): Promise&#60;void&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream1",
"type": "[`ReadableStream`](../../internal/interfaces/internal.ReadableStream-1.mdx)",
"type": "[ReadableStream](../../internal/interfaces/internal.ReadableStream-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -395,7 +395,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "stream2",
"type": "[`WritableStream`](../../internal/interfaces/internal.WritableStream.mdx) \\| [`ReadWriteStream`](../../internal/interfaces/internal.ReadWriteStream.mdx)",
"type": "[WritableStream](../../internal/interfaces/internal.WritableStream.mdx) \\| [ReadWriteStream](../../internal/interfaces/internal.ReadWriteStream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -404,7 +404,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "streams",
"type": "([`WritableStream`](../../internal/interfaces/internal.WritableStream.mdx) \\| [`ReadWriteStream`](../../internal/interfaces/internal.ReadWriteStream.mdx) \\| [`PipelineOptions`](../interfaces/internal.internal-3.PipelineOptions.mdx))[]",
"type": "([WritableStream](../../internal/interfaces/internal.WritableStream.mdx) \\| [ReadWriteStream](../../internal/interfaces/internal.ReadWriteStream.mdx) \\| [PipelineOptions](../interfaces/internal.internal-3.PipelineOptions.mdx))[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -418,7 +418,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",