@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx

@@ -2,10 +2,6 @@
 title: "UiDevkitClient"
 generated: true
 ---
-
-
-## setTargetOrigin
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="24" packageName="@vendure/ui-devkit" />
 
 Set the [window.postMessage API](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage)
@@ -22,10 +18,6 @@ Parameters
 
 <MemberInfo kind="parameter" type={`string`} />
 
-
-
-## getActivatedRoute
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="43" packageName="@vendure/ui-devkit" />
 
 Retrieves information about the current route of the host application, since it is not possible
@@ -43,10 +35,6 @@ const slug = route.params.slug;
 ```ts title="Signature"
 function getActivatedRoute(): Promise<ActiveRouteData>
 ```
-
-
-## graphQlQuery
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="70" packageName="@vendure/ui-devkit" />
 
 Perform a GraphQL query and returns either an Observable or a Promise of the result.
@@ -88,10 +76,6 @@ Parameters
 
 <MemberInfo kind="parameter" type={`WatchQueryFetchPolicy`} />
 
-
-
-## graphQlMutation
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="112" packageName="@vendure/ui-devkit" />
 
 Perform a GraphQL mutation and returns either an Observable or a Promise of the result.
@@ -129,10 +113,6 @@ Parameters
 
 <MemberInfo kind="parameter" type={`{ [key: string]: any }`} />
 
-
-
-## notify
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="147" packageName="@vendure/ui-devkit" />
 
 Display a toast notification.

package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx

@@ -2,10 +2,6 @@
 title: "UiExtensionBuildCommand"
 generated: true
 ---
-
-
-## UiExtensionBuildCommand
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="356" packageName="@vendure/ui-devkit" />
 
 The package manager to use when invoking the Angular CLI to build UI extensions.

package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx

@@ -2,10 +2,6 @@
 title: "UiExtensionCompilerOptions"
 generated: true
 ---
-
-
-## UiExtensionCompilerOptions
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="364" packageName="@vendure/ui-devkit" />
 
 Options to configure how the Admin UI should be compiled.
@@ -72,7 +68,7 @@ Allows the baseHref of the compiled Admin UI app to be set. This determines the
 of the app, for example with the default value of `'/admin/'`, the Admin UI app
 will be configured to be served from `http://<host>/admin/`.
 
-Note: if you are using this in conjunction with the <a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a> then you should
+Note: if you are using this in conjunction with the <DocsLink href="/reference/core-plugins/admin-ui-plugin/#adminuiplugin">AdminUiPlugin</DocsLink> then you should
 also set the `route` option to match this value.
 
 *Example*

package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx

@@ -2,10 +2,6 @@
 title: "UiExtensionCompilerProcessArgument"
 generated: true
 ---
-
-
-## UiExtensionCompilerProcessArgument
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="348" packageName="@vendure/ui-devkit" />
 
 Argument to configure process (watch or compile)

package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx

@@ -2,13 +2,9 @@
 title: "AdminUiPluginOptions"
 generated: true
 ---
-
-
-## AdminUiPluginOptions
-
 <GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="44" packageName="@vendure/admin-ui-plugin" />
 
-Configuration options for the <a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>.
+Configuration options for the <DocsLink href="/reference/core-plugins/admin-ui-plugin/#adminuiplugin">AdminUiPlugin</DocsLink>.
 
 ```ts title="Signature"
 interface AdminUiPluginOptions {
@@ -52,7 +48,7 @@ Admin UI. This option can be used to override this default build with a differen
 version, e.g. one pre-compiled with one or more ui extensions.
 ### adminUiConfig
 
-<MemberInfo kind="property" type={`Partial&#60;<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>&#62;`}   />
+<MemberInfo kind="property" type={`Partial<<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>>`}   />
 
 Allows the contents of the `vendure-ui-config.json` file to be set, e.g.
 for specifying the Vendure GraphQL API host, available UI languages, etc.

package/docs/reference/core-plugins/admin-ui-plugin/index.mdx

@@ -2,10 +2,6 @@
 title: "AdminUiPlugin"
 generated: true
 ---
-
-
-## AdminUiPlugin
-
 <GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="147" packageName="@vendure/admin-ui-plugin" />
 
 :::warning Deprecated
@@ -80,7 +76,7 @@ class AdminUiPlugin implements NestModule {
 
 ### init
 
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type&#60;<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type<<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>>`}   />
 
 Set the plugin options
 ### configure

package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx

@@ -2,10 +2,6 @@
 title: "AssetServerOptions"
 generated: true
 ---
-
-
-## AssetServerOptions
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="74" packageName="@vendure/asset-server-plugin" />
 
 The configuration options for the AssetServerPlugin.
@@ -39,10 +35,10 @@ The route to the asset server.
 
 <MemberInfo kind="property" type={`string`}   />
 
-The local directory to which assets will be uploaded when using the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>.
+The local directory to which assets will be uploaded when using the <DocsLink href="/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy">LocalAssetStorageStrategy</DocsLink>.
 ### assetUrlPrefix
 
-<MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) =&#62; string)`}   />
+<MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) => string)`}   />
 
 The complete URL prefix of the asset files. For example, "https://demo.vendure.io/assets/". A
 function can also be provided to handle more complex cases, such as serving multiple domains
@@ -65,7 +61,7 @@ The max height in pixels of a generated preview image.
 
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/image-transform-preset#imagetransformpreset'>ImageTransformPreset</a>[]`}   />
 
-An array of additional <a href='/reference/core-plugins/asset-server-plugin/image-transform-preset#imagetransformpreset'>ImageTransformPreset</a> objects.
+An array of additional <DocsLink href="/reference/core-plugins/asset-server-plugin/image-transform-preset#imagetransformpreset">ImageTransformPreset</DocsLink> objects.
 ### imageTransformStrategy
 
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy'>ImageTransformStrategy</a> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy'>ImageTransformStrategy</a>[]`} default={`[]`}  since="3.1.0"  />
@@ -87,13 +83,13 @@ Defines how asset files and preview images are named before being saved.
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a>`}  since="1.7.0"  />
 
 Defines how previews are generated for a given Asset binary. By default, this uses
-the <a href='/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewstrategy'>SharpAssetPreviewStrategy</a>
+the <DocsLink href="/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewstrategy">SharpAssetPreviewStrategy</DocsLink>
 ### storageStrategyFactory
 
-<MemberInfo kind="property" type={`(         options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>,     ) =&#62; <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> | Promise&#60;<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>&#62;`} default={`() =&#62; <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`}   />
+<MemberInfo kind="property" type={`(         options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>,     ) => <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> | Promise<<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>>`} default={`() => <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`}   />
 
-A function which can be used to configure an <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>. This is useful e.g. if you wish to store your assets
-using a cloud storage provider. By default, the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a> is used.
+A function which can be used to configure an <DocsLink href="/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy">AssetStorageStrategy</DocsLink>. This is useful e.g. if you wish to store your assets
+using a cloud storage provider. By default, the <DocsLink href="/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy">LocalAssetStorageStrategy</DocsLink> is used.
 ### cacheHeader
 
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/cache-config#cacheconfig'>CacheConfig</a> | string`} default={`'public, max-age=15552000'`}  since="1.9.3"  />

package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx

@@ -2,10 +2,6 @@
 title: "CacheConfig"
 generated: true
 ---
-
-
-## CacheConfig
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="54" packageName="@vendure/asset-server-plugin" />
 
 A configuration option for the Cache-Control header in the AssetServerPlugin asset response.

package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx

@@ -2,13 +2,9 @@
 title: "HashedAssetNamingStrategy"
 generated: true
 ---
-
-
-## HashedAssetNamingStrategy
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/hashed-asset-naming-strategy.ts" sourceLine="20" packageName="@vendure/asset-server-plugin" />
 
-An extension of the <a href='/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy'>DefaultAssetNamingStrategy</a> which prefixes file names with
+An extension of the <DocsLink href="/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy">DefaultAssetNamingStrategy</DocsLink> which prefixes file names with
 the type (`'source'` or `'preview'`) as well as a 2-character sub-directory based on
 the md5 hash of the original file name.
 

package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx

@@ -2,10 +2,6 @@
 title: "ImageTransformMode"
 generated: true
 ---
-
-
-## ImageTransformMode
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="23" packageName="@vendure/asset-server-plugin" />
 
 Specifies the way in which an asset preview image will be resized to fit in the

package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx

@@ -2,10 +2,6 @@
 title: "ImageTransformPreset"
 generated: true
 ---
-
-
-## ImageTransformPreset
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="41" packageName="@vendure/asset-server-plugin" />
 
 A configuration option for an image size preset for the AssetServerPlugin.

package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx

@@ -2,10 +2,6 @@
 title: "ImageTransformStrategy"
 generated: true
 ---
-
-
-## ImageTransformStrategy
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/image-transform-strategy.ts" sourceLine="56" packageName="@vendure/asset-server-plugin" since="3.1.0" />
 
 An injectable strategy which is used to determine the parameters for transforming an image.
@@ -33,16 +29,12 @@ interface ImageTransformStrategy extends InjectableStrategy {
 
 ### getImageTransformParameters
 
-<MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise&#60;<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>&#62; | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`}   />
+<MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`}   />
 
 Given the input parameters, return the parameters which should be used to transform the image.
 
 
 </div>
-
-
-## ImageTransformParameters
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/image-transform-strategy.ts" sourceLine="14" packageName="@vendure/asset-server-plugin" since="3.1.0" />
 
 Parameters which are used to transform the image.
@@ -105,10 +97,6 @@ interface ImageTransformParameters {
 
 
 </div>
-
-
-## GetImageTransformParametersArgs
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/image-transform-strategy.ts" sourceLine="33" packageName="@vendure/asset-server-plugin" since="3.1.0" />
 
 The arguments passed to the `getImageTransformParameters` method of an ImageTransformStrategy.

package/docs/reference/core-plugins/asset-server-plugin/index.mdx

@@ -2,14 +2,10 @@
 title: "AssetServerPlugin"
 generated: true
 ---
-
-
-## AssetServerPlugin
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/plugin.ts" sourceLine="176" packageName="@vendure/asset-server-plugin" />
 
 The `AssetServerPlugin` serves assets (images and other files) from the local file system, and can also be configured to use
-other storage strategies (e.g. <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3assetstoragestrategy'>S3AssetStorageStrategy</a>. It can also perform on-the-fly image transformations
+other storage strategies (e.g. <DocsLink href="/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3assetstoragestrategy">S3AssetStorageStrategy</DocsLink>. It can also perform on-the-fly image transformations
 and caches the results for subsequent calls.
 
 ## Installation
@@ -131,11 +127,11 @@ a given configuration. Caching can be disabled per-request by setting the `?cach
 ### Limiting transformations
 
 By default, the AssetServerPlugin will allow any transformation to be performed on an image. However, it is possible to restrict the transformations
-which can be performed by using an <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy'>ImageTransformStrategy</a>. This can be used to limit the transformations to a known set of presets, for example.
+which can be performed by using an <DocsLink href="/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy">ImageTransformStrategy</DocsLink>. This can be used to limit the transformations to a known set of presets, for example.
 
 This is advisable in order to prevent abuse of the image transformation feature, as it can be computationally expensive.
 
-Since v3.1.0 we ship with a <a href='/reference/core-plugins/asset-server-plugin/preset-only-strategy#presetonlystrategy'>PresetOnlyStrategy</a> which allows only transformations using a known set of presets.
+Since v3.1.0 we ship with a <DocsLink href="/reference/core-plugins/asset-server-plugin/preset-only-strategy#presetonlystrategy">PresetOnlyStrategy</DocsLink> which allows only transformations using a known set of presets.
 
 *Example*
 
@@ -170,7 +166,7 @@ class AssetServerPlugin implements NestModule, OnApplicationBootstrap, OnApplica
 
 ### init
 
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => Type&#60;<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => Type<<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>>`}   />
 
 Set the plugin options.
 ### constructor

package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx

@@ -2,10 +2,6 @@
 title: "LocalAssetStorageStrategy"
 generated: true
 ---
-
-
-## LocalAssetStorageStrategy
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/local-asset-storage-strategy.ts" sourceLine="15" packageName="@vendure/asset-server-plugin" />
 
 A persistence strategy which saves files to the local file system.
@@ -30,42 +26,42 @@ class LocalAssetStorageStrategy implements AssetStorageStrategy {
 
 ### toAbsoluteUrl
 
-<MemberInfo kind="property" type={`((reqest: Request, identifier: string) =&#62; string) | undefined`}   />
+<MemberInfo kind="property" type={`((reqest: Request, identifier: string) => string) | undefined`}   />
 
 
 ### constructor
 
-<MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string) =&#62; string) => LocalAssetStorageStrategy`}   />
+<MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string) => string) => LocalAssetStorageStrategy`}   />
 
 
 ### writeFileFromStream
 
-<MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => Promise&#60;string&#62;`}   />
+<MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => Promise<string>`}   />
 
 
 ### writeFileFromBuffer
 
-<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise&#60;string&#62;`}   />
+<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise<string>`}   />
 
 
 ### fileExists
 
-<MemberInfo kind="method" type={`(fileName: string) => Promise&#60;boolean&#62;`}   />
+<MemberInfo kind="method" type={`(fileName: string) => Promise<boolean>`}   />
 
 
 ### readFileToBuffer
 
-<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;Buffer&#62;`}   />
+<MemberInfo kind="method" type={`(identifier: string) => Promise<Buffer>`}   />
 
 
 ### readFileToStream
 
-<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;Stream&#62;`}   />
+<MemberInfo kind="method" type={`(identifier: string) => Promise<Stream>`}   />
 
 
 ### deleteFile
 
-<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(identifier: string) => Promise<void>`}   />
 
 
 

package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx

@@ -2,13 +2,9 @@
 title: "PresetOnlyStrategy"
 generated: true
 ---
-
-
-## PresetOnlyStrategy
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/preset-only-strategy.ts" sourceLine="85" packageName="@vendure/asset-server-plugin" since="3.1.0" />
 
-An <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy'>ImageTransformStrategy</a> which only allows transformations to be made using
+An <DocsLink href="/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy">ImageTransformStrategy</DocsLink> which only allows transformations to be made using
 presets which are defined in the available presets.
 
 With this strategy enabled, requests to the asset server must include a `preset` parameter (or use the default preset)
@@ -65,19 +61,15 @@ class PresetOnlyStrategy implements ImageTransformStrategy {
 <MemberInfo kind="method" type={`({
         input,
         availablePresets,
-    }: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise&#60;<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>&#62; | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`}   />
+    }: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`}   />
 
 
 
 
 </div>
-
-
-## PresetOnlyStrategyOptions
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/preset-only-strategy.ts" sourceLine="16" packageName="@vendure/asset-server-plugin" />
 
-Configuration options for the <a href='/reference/core-plugins/asset-server-plugin/preset-only-strategy#presetonlystrategy'>PresetOnlyStrategy</a>.
+Configuration options for the <DocsLink href="/reference/core-plugins/asset-server-plugin/preset-only-strategy#presetonlystrategy">PresetOnlyStrategy</DocsLink>.
 
 ```ts title="Signature"
 interface PresetOnlyStrategyOptions {

package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx

@@ -2,13 +2,9 @@
 title: "S3AssetStorageStrategy"
 generated: true
 ---
-
-
-## S3AssetStorageStrategy
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/s3-asset-storage-strategy.ts" sourceLine="155" packageName="@vendure/asset-server-plugin" />
 
-An <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> which uses [Amazon S3](https://aws.amazon.com/s3/) object storage service.
+An <DocsLink href="/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy">AssetStorageStrategy</DocsLink> which uses [Amazon S3](https://aws.amazon.com/s3/) object storage service.
 To us this strategy you must first have access to an AWS account.
 See their [getting started guide](https://aws.amazon.com/s3/getting-started/) for how to get set up.
 
@@ -18,11 +14,11 @@ Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aw
 npm install @aws-sdk/client-s3 @aws-sdk/lib-storage
 ```
 
-**Note:** Rather than instantiating this manually, use the <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#configures3assetstorage'>configureS3AssetStorage</a> function.
+**Note:** Rather than instantiating this manually, use the <DocsLink href="/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#configures3assetstorage">configureS3AssetStorage</DocsLink> function.
 
 ## Use with S3-compatible services (MinIO)
 This strategy will also work with any S3-compatible object storage solutions, such as [MinIO](https://min.io/).
-See the <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#configures3assetstorage'>configureS3AssetStorage</a> for an example with MinIO.
+See the <DocsLink href="/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#configures3assetstorage">configureS3AssetStorage</DocsLink> for an example with MinIO.
 
 ```ts title="Signature"
 class S3AssetStorageStrategy implements AssetStorageStrategy {
@@ -45,7 +41,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: (request: Request, identifier: string) =&#62; string) => S3AssetStorageStrategy`}   />
+<MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: (request: Request, identifier: string) => string) => S3AssetStorageStrategy`}   />
 
 
 ### init
@@ -55,7 +51,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
 
 ### destroy
 
-<MemberInfo kind="property" type={`(() =&#62; void | Promise&#60;void&#62;) | undefined`}   />
+<MemberInfo kind="property" type={`(() => void | Promise<void>) | undefined`}   />
 
 
 ### writeFileFromBuffer
@@ -91,10 +87,6 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
 
 
 </div>
-
-
-## S3Config
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/s3-asset-storage-strategy.ts" sourceLine="19" packageName="@vendure/asset-server-plugin" />
 
 Configuration for connecting to AWS S3.
@@ -140,13 +132,9 @@ Using type `any` in order to avoid the need to include `aws-sdk` dependency in g
 
 
 </div>
-
-
-## configureS3AssetStorage
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/s3-asset-storage-strategy.ts" sourceLine="119" packageName="@vendure/asset-server-plugin" />
 
-Returns a configured instance of the <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3assetstoragestrategy'>S3AssetStorageStrategy</a> which can then be passed to the <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>`storageStrategyFactory` property.
+Returns a configured instance of the <DocsLink href="/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3assetstoragestrategy">S3AssetStorageStrategy</DocsLink> which can then be passed to the <DocsLink href="/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions">AssetServerOptions</DocsLink>`storageStrategyFactory` property.
 
 Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aws-sdk/lib-storage` package installed:
 

package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx

@@ -2,13 +2,9 @@
 title: "SharpAssetPreviewStrategy"
 generated: true
 ---
-
-
-## SharpAssetPreviewStrategy
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/sharp-asset-preview-strategy.ts" sourceLine="95" packageName="@vendure/asset-server-plugin" />
 
-This <a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a> uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
+This <DocsLink href="/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy">AssetPreviewStrategy</DocsLink> uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
 preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
 overlay will be generated.
 
@@ -47,19 +43,15 @@ class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
 
 ### generatePreviewImage
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise&#60;Buffer&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise<Buffer>`}   />
 
 
 
 
 </div>
-
-
-## SharpAssetPreviewConfig
-
 <GenerationInfo sourceFile="packages/asset-server-plugin/src/config/sharp-asset-preview-strategy.ts" sourceLine="17" packageName="@vendure/asset-server-plugin" />
 
-This <a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a> uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
+This <DocsLink href="/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy">AssetPreviewStrategy</DocsLink> uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
 preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
 overlay will be generated.
 

package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx

@@ -2,13 +2,9 @@
 title: "DashboardPluginOptions"
 generated: true
 ---
-
-
-## DashboardPluginOptions
-
 <GenerationInfo sourceFile="packages/dashboard/plugin/dashboard.plugin.ts" sourceLine="29" packageName="@vendure/dashboard" />
 
-Configuration options for the <a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>.
+Configuration options for the <DocsLink href="/reference/core-plugins/dashboard-plugin/#dashboardplugin">DashboardPlugin</DocsLink>.
 
 ```ts title="Signature"
 interface DashboardPluginOptions {

package/docs/reference/core-plugins/dashboard-plugin/index.mdx

@@ -2,10 +2,6 @@
 title: "DashboardPlugin"
 generated: true
 ---
-
-
-## DashboardPlugin
-
 <GenerationInfo sourceFile="packages/dashboard/plugin/dashboard.plugin.ts" sourceLine="119" packageName="@vendure/dashboard" />
 
 This plugin serves the static files of the Vendure Dashboard and provides the
@@ -92,7 +88,7 @@ class DashboardPlugin implements NestModule {
 
 ### init
 
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => Type&#60;<a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => Type<<a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>>`}   />
 
 Set the plugin options
 ### configure