@vendure/docs 0.0.0-202601271334 → 0.0.0-202601281114

package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx

@@ -6,7 +6,7 @@ generated: true
 
 The EmailEventHandler defines how the EmailPlugin will respond to a given event.
 
-A handler is created by creating a new <DocsLink href="/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener">EmailEventListener</DocsLink> and calling the `.on()` method
+A handler is created by creating a new [EmailEventListener](/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener) and calling the `.on()` method
 to specify which event to respond to.
 
 *Example*
@@ -34,9 +34,9 @@ By default, the handler will respond to all events on all channels and use the s
 and body template.
 
 Since v2.0 the `.addTemplate()` method has been **deprecated**. To serve different templates — for example, based on the current
-`languageCode` — implement a custom <DocsLink href="/reference/core-plugins/email-plugin/template-loader#templateloader">TemplateLoader</DocsLink> and pass it to `EmailPlugin.init({ templateLoader: new MyTemplateLoader() })`.
+`languageCode` — implement a custom [TemplateLoader](/reference/core-plugins/email-plugin/template-loader#templateloader) and pass it to `EmailPlugin.init({ templateLoader: new MyTemplateLoader() })`.
 
-The language is typically determined by the `languageCode` property of the event's `ctx` (<DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink>) object, so the
+The language is typically determined by the `languageCode` property of the event's `ctx` ([RequestContext](/reference/typescript-api/request/request-context#requestcontext)) object, so the
 `loadTemplate()` method can use that to locate the correct template file.
 
 *Example*
@@ -65,7 +65,7 @@ EmailPlugin.init({
 ## Defining a custom handler
 
 Let's say you have a plugin which defines a new event type, `QuoteRequestedEvent`. In your plugin you have defined a mutation
-which is executed when the customer requests a quote in your storefront, and in your resolver, you use the <DocsLink href="/reference/typescript-api/events/event-bus#eventbus">EventBus</DocsLink> to publish a
+which is executed when the customer requests a quote in your storefront, and in your resolver, you use the [EventBus](/reference/typescript-api/events/event-bus#eventbus) to publish a
 new `QuoteRequestedEvent`.
 
 You now want to email the customer with their quote. Here are the steps you would take to set this up:
@@ -197,17 +197,17 @@ setTemplateVars() method.
 
 <MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a><Event>) => `}  since="1.1.0"  />
 
-A function which allows <DocsLink href="/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields">OptionalAddressFields</DocsLink> to be specified such as "cc" and "bcc".
+A function which allows [OptionalAddressFields](/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields) to be specified such as "cc" and "bcc".
 ### setMetadata
 
 <MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a><Event>) => `}  since="3.1.0"  />
 
-A function which allows <DocsLink href="/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata">EmailMetadata</DocsLink> to be specified for the email. This can be used
+A function which allows [EmailMetadata](/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata) to be specified for the email. This can be used
 to store arbitrary data about the email which can be used for tracking or other purposes.
 
-It will be exposed in the <DocsLink href="/reference/core-plugins/email-plugin/email-send-event#emailsendevent">EmailSendEvent</DocsLink> as `event.metadata`. Here's an example of usage:
+It will be exposed in the [EmailSendEvent](/reference/core-plugins/email-plugin/email-send-event#emailsendevent) as `event.metadata`. Here's an example of usage:
 
-- An <DocsLink href="/reference/typescript-api/events/event-types#orderstatetransitionevent">OrderStateTransitionEvent</DocsLink> occurs, and the EmailEventListener starts processing it.
+- An [OrderStateTransitionEvent](/reference/typescript-api/events/event-types#orderstatetransitionevent) occurs, and the EmailEventListener starts processing it.
 - The EmailEventHandler attaches metadata to the email:
    ```ts
    new EmailEventListener(EventType.ORDER_CONFIRMATION)
@@ -217,7 +217,7 @@ It will be exposed in the <DocsLink href="/reference/core-plugins/email-plugin/e
        orderId: event.order.id,
      }));
   ```
-- Then, the EmailPlugin tries to send the email and publishes <DocsLink href="/reference/core-plugins/email-plugin/email-send-event#emailsendevent">EmailSendEvent</DocsLink>,
+- Then, the EmailPlugin tries to send the email and publishes [EmailSendEvent](/reference/core-plugins/email-plugin/email-send-event#emailsendevent),
   passing ctx, emailDetails, error or success, and this metadata.
 - In another part of the server, we have an eventBus that subscribes to EmailSendEvent. We can use
   `metadata.type` and `metadata.orderId` to identify the related order. For example, we can indicate on the
@@ -264,7 +264,7 @@ templates for channels or languageCodes other than the default.
 Allows data to be loaded asynchronously which can then be used as template variables.
 The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
 `inject()` function which can be used to inject any of the providers exported
-by the <DocsLink href="/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule">PluginCommonModule</DocsLink>. The return value of the `loadDataFn` will be
+by the [PluginCommonModule](/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule). The return value of the `loadDataFn` will be
 added to the `event` as the `data` property.
 
 *Example*

package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/email-plugin/src/event-listener.ts" sourceLine="13" packageName="@vendure/email-plugin" />
 
-An EmailEventListener is used to listen for events and set up a <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink> which
+An EmailEventListener is used to listen for events and set up a [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler) which
 defines how an email will be generated from this event.
 
 ```ts title="Signature"

package/docs/reference/core-plugins/email-plugin/email-generator.mdx

@@ -17,7 +17,7 @@ interface EmailGenerator<T extends string = any, E extends VendureEvent = any> e
     ): Pick<EmailDetails, 'from' | 'subject' | 'body'>;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
+* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
 
 
 
@@ -48,7 +48,7 @@ class HandlebarsMjmlGenerator implements EmailGenerator {
     generate(from: string, subject: string, template: string, templateVars: any) => ;
 }
 ```
-* Implements: <DocsLink href="/reference/core-plugins/email-plugin/email-generator#emailgenerator">`EmailGenerator`</DocsLink>
+* Implements: [`EmailGenerator`](/reference/core-plugins/email-plugin/email-generator#emailgenerator)
 
 
 

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

@@ -46,7 +46,7 @@ Configures how the emails are sent.
 
 <MemberInfo kind="property" type={`Array<<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><string, any>>`}   />
 
-An array of <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink>s which define which Vendure events will trigger
+An array of [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler)s which define which Vendure events will trigger
 emails, and how those emails are generated.
 ### globalTemplateVars
 
@@ -115,7 +115,7 @@ interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'transport'
     route: string;
 }
 ```
-* Extends: `Omit<`<DocsLink href="/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions">`EmailPluginOptions`</DocsLink>`, 'transport'>`
+* Extends: `Omit<`[`EmailPluginOptions`](/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions)`, 'transport'>`
 
 
 

package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx

@@ -5,7 +5,7 @@ generated: true
 <GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="22" packageName="@vendure/email-plugin" />
 
 A VendureEvent which also includes a `ctx` property containing the current
-<DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink>, which is used to determine the channel and language
+[RequestContext](/reference/typescript-api/request/request-context#requestcontext), which is used to determine the channel and language
 to use when generating the email.
 
 ```ts title="Signature"
@@ -13,8 +13,8 @@ type EventWithContext = VendureEvent & { ctx: RequestContext }
 ```
 <GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="32" packageName="@vendure/email-plugin" />
 
-A VendureEvent with a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> and a `data` property which contains the
-value resolved from the <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink>`.loadData()` callback.
+A VendureEvent with a [RequestContext](/reference/typescript-api/request/request-context#requestcontext) and a `data` property which contains the
+value resolved from the [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler)`.loadData()` callback.
 
 ```ts title="Signature"
 type EventWithAsyncData<Event extends EventWithContext, R> = Event & { data: R }
@@ -83,7 +83,7 @@ interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialize
 </div>
 <GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="322" packageName="@vendure/email-plugin" />
 
-A function used to load async data for use by an <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink>.
+A function used to load async data for use by an [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler).
 
 ```ts title="Signature"
 type LoadDataFn<Event extends EventWithContext, R> = (context: {
@@ -103,7 +103,7 @@ type EmailAttachment = Omit<Attachment, 'raw'> & { path?: string }
 ```
 <GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="402" packageName="@vendure/email-plugin" />
 
-The object passed to the <DocsLink href="/reference/core-plugins/email-plugin/template-loader#templateloader">TemplateLoader</DocsLink> `loadTemplate()` method.
+The object passed to the [TemplateLoader](/reference/core-plugins/email-plugin/template-loader#templateloader) `loadTemplate()` method.
 
 ```ts title="Signature"
 interface LoadTemplateInput {
@@ -138,7 +138,7 @@ EmailEventHandler's `setTemplateVars()` method.
 <GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="435" packageName="@vendure/email-plugin" />
 
 A function used to define template variables available to email templates.
-See <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink>.setTemplateVars().
+See [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler).setTemplateVars().
 
 ```ts title="Signature"
 type SetTemplateVarsFn<Event> = (
@@ -200,7 +200,7 @@ An email address that will appear on the _Reply-To:_ field
 </div>
 <GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="497" packageName="@vendure/email-plugin" since="1.1.0" />
 
-A function used to set the <DocsLink href="/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields">OptionalAddressFields</DocsLink>.
+A function used to set the [OptionalAddressFields](/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields).
 
 ```ts title="Signature"
 type SetOptionalAddressFieldsFn<Event> = (
@@ -209,14 +209,14 @@ type SetOptionalAddressFieldsFn<Event> = (
 ```
 <GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="509" packageName="@vendure/email-plugin" since="3.1.0" />
 
-A function used to set the <DocsLink href="/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata">EmailMetadata</DocsLink>.
+A function used to set the [EmailMetadata](/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata).
 
 ```ts title="Signature"
 type SetMetadataFn<Event> = (event: Event) => EmailMetadata | Promise<EmailMetadata>
 ```
 <GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="519" packageName="@vendure/email-plugin" since="3.1.0" />
 
-Metadata that can be attached to an email via the <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink>`.setMetadata()` method.
+Metadata that can be attached to an email via the [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler)`.setMetadata()` method.
 
 ```ts title="Signature"
 type EmailMetadata = Record<string, any>

package/docs/reference/core-plugins/email-plugin/email-send-event.mdx

@@ -13,7 +13,7 @@ class EmailSendEvent extends VendureEvent {
     constructor(ctx: RequestContext, details: EmailDetails, success: boolean, error?: Error, metadata?: EmailMetadata)
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/events/vendure-event#vendureevent">`VendureEvent`</DocsLink>
+* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
 
 
 

package/docs/reference/core-plugins/email-plugin/email-sender.mdx

@@ -6,7 +6,7 @@ generated: true
 
 An EmailSender is responsible for sending the email, e.g. via an SMTP connection
 or using some other mail-sending API. By default, the EmailPlugin uses the
-<DocsLink href="/reference/core-plugins/email-plugin/email-sender#nodemaileremailsender">NodemailerEmailSender</DocsLink>, but it is also possible to supply a custom implementation:
+[NodemailerEmailSender](/reference/core-plugins/email-plugin/email-sender#nodemaileremailsender), but it is also possible to supply a custom implementation:
 
 *Example*
 
@@ -44,7 +44,7 @@ interface EmailSender extends InjectableStrategy {
     send: (email: EmailDetails, options: EmailTransportOptions) => void | Promise<void>;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
+* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
 
 
 
@@ -67,7 +67,7 @@ class NodemailerEmailSender implements EmailSender {
     send(email: EmailDetails, options: EmailTransportOptions) => ;
 }
 ```
-* Implements: <DocsLink href="/reference/core-plugins/email-plugin/email-sender#emailsender">`EmailSender`</DocsLink>
+* Implements: [`EmailSender`](/reference/core-plugins/email-plugin/email-sender#emailsender)
 
 
 

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

@@ -8,7 +8,7 @@ The EmailPlugin creates and sends transactional emails based on Vendure events.
 email generator to generate the email body and [Nodemailer](https://nodemailer.com/about/) to send the emails.
 
 ## High-level description
-Vendure has an internal events system (see <DocsLink href="/reference/typescript-api/events/event-bus#eventbus">EventBus</DocsLink>) that allows plugins to subscribe to events. The EmailPlugin is configured with <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink>s
+Vendure has an internal events system (see [EventBus](/reference/typescript-api/events/event-bus#eventbus)) that allows plugins to subscribe to events. The EmailPlugin is configured with [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler)s
 that listen for a specific event and when it is published, the handler defines which template to use to generate the resulting email.
 
 The plugin comes with a set of default handler for the following events:
@@ -17,7 +17,7 @@ The plugin comes with a set of default handler for the following events:
 - Password reset request
 - Email address change request
 
-You can also create your own handler and register them with the plugin - see the <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink> docs for more details.
+You can also create your own handler and register them with the plugin - see the [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler) docs for more details.
 
 ## Installation
 
@@ -188,7 +188,7 @@ EmailPlugin.init({
 }),
 ```
 
-For all available methods of extending a handler, see the <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink> documentation.
+For all available methods of extending a handler, see the [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler) documentation.
 
 ## Dynamic SMTP settings
 
@@ -224,7 +224,7 @@ const config: VendureConfig = {
 ## Dev mode
 
 For development, the `transport` option can be replaced by `devMode: true`. Doing so configures Vendure to use the
-file transport (See <DocsLink href="/reference/core-plugins/email-plugin/transport-options#filetransportoptions">FileTransportOptions</DocsLink>) and outputs emails as rendered HTML files in the directory specified by the
+file transport (See [FileTransportOptions](/reference/core-plugins/email-plugin/transport-options#filetransportoptions)) and outputs emails as rendered HTML files in the directory specified by the
 `outputPath` property.
 
 ```ts

package/docs/reference/core-plugins/email-plugin/template-loader.mdx

@@ -61,7 +61,7 @@ class FileBasedTemplateLoader implements TemplateLoader {
     loadPartials() => Promise<Partial[]>;
 }
 ```
-* Implements: <DocsLink href="/reference/core-plugins/email-plugin/template-loader#templateloader">`TemplateLoader`</DocsLink>
+* Implements: [`TemplateLoader`](/reference/core-plugins/email-plugin/template-loader#templateloader)
 
 
 

package/docs/reference/core-plugins/email-plugin/transport-options.mdx

@@ -39,7 +39,7 @@ interface SMTPTransportOptions extends SMTPTransport.Options {
 
 <MemberInfo kind="property" type={`boolean`} default={`false`}   />
 
-If true, uses the configured <DocsLink href="/reference/typescript-api/logger/vendure-logger#vendurelogger">VendureLogger</DocsLink> to log messages from Nodemailer as it interacts with
+If true, uses the configured [VendureLogger](/reference/typescript-api/logger/vendure-logger#vendurelogger) to log messages from Nodemailer as it interacts with
 the SMTP server.
 
 
@@ -166,7 +166,7 @@ interface FileTransportOptions {
 <GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="277" packageName="@vendure/email-plugin" />
 
 Does nothing with the generated email. Intended for use in testing where we don't care about the email transport,
-or when using a custom <DocsLink href="/reference/core-plugins/email-plugin/email-sender#emailsender">EmailSender</DocsLink> which does not require transport options.
+or when using a custom [EmailSender](/reference/core-plugins/email-plugin/email-sender#emailsender) which does not require transport options.
 
 ```ts title="Signature"
 interface NoopTransportOptions {

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

@@ -36,7 +36,7 @@ A query which exceeds the maximum score will result in an error.
 <MemberInfo kind="property" type={`ComplexityEstimator[]`}   />
 
 An array of custom estimator functions for calculating the complexity of a query. By default,
-the plugin will use the <DocsLink href="/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator#defaultvendurecomplexityestimator">defaultVendureComplexityEstimator</DocsLink> which is specifically
+the plugin will use the [defaultVendureComplexityEstimator](/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator#defaultvendurecomplexityestimator) which is specifically
 tuned to accurately estimate Vendure queries.
 ### logComplexityScore
 

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

@@ -21,7 +21,7 @@ or
 
 `npm install @vendure/harden-plugin`
 
-Then add the `HardenPlugin`, calling the `.init()` method with <DocsLink href="/reference/core-plugins/harden-plugin/harden-plugin-options#hardenpluginoptions">HardenPluginOptions</DocsLink>:
+Then add the `HardenPlugin`, calling the `.init()` method with [HardenPluginOptions](/reference/core-plugins/harden-plugin/harden-plugin-options#hardenpluginoptions):
 
 *Example*
 
@@ -79,7 +79,7 @@ query EvilQuery {
 This evil query has a complexity score of 2,443,203 - much greater than the default of 1,000!
 
 The complexity score is calculated by the [graphql-query-complexity library](https://www.npmjs.com/package/graphql-query-complexity),
-and by default uses the <DocsLink href="/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator#defaultvendurecomplexityestimator">defaultVendureComplexityEstimator</DocsLink>, which is tuned specifically to the Vendure Shop API.
+and by default uses the [defaultVendureComplexityEstimator](/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator#defaultvendurecomplexityestimator), which is tuned specifically to the Vendure Shop API.
 
 :::caution
 Note: By default, if the "take" argument is omitted from a list query (e.g. the `products` or `collections` query), a default factor of 1000 is applied.

package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx

@@ -5,7 +5,7 @@ generated: true
 <GenerationInfo sourceFile="packages/job-queue-plugin/src/bullmq/bullmq-job-queue-strategy.ts" sourceLine="53" packageName="@vendure/job-queue-plugin" />
 
 This JobQueueStrategy uses [BullMQ](https://docs.bullmq.io/) to implement a push-based job queue
-on top of Redis. It should not be used alone, but as part of the <DocsLink href="/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin">BullMQJobQueuePlugin</DocsLink>.
+on top of Redis. It should not be used alone, but as part of the [BullMQJobQueuePlugin](/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin).
 
 Note: To use this strategy, you need to manually install the `bullmq` package:
 

package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/job-queue-plugin/src/bullmq/types.ts" sourceLine="21" packageName="@vendure/job-queue-plugin" since="1.2.0" />
 
-Configuration options for the <DocsLink href="/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin">BullMQJobQueuePlugin</DocsLink>.
+Configuration options for the [BullMQJobQueuePlugin](/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin).
 
 ```ts title="Signature"
 interface BullMQPluginOptions {

package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx

@@ -5,7 +5,7 @@ generated: true
 <GenerationInfo sourceFile="packages/job-queue-plugin/src/pub-sub/pub-sub-job-queue-strategy.ts" sourceLine="29" packageName="@vendure/job-queue-plugin" />
 
 This JobQueueStrategy uses Google Cloud Pub/Sub to implement a job queue for Vendure.
-It should not be used alone, but as part of the <DocsLink href="/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin">PubSubPlugin</DocsLink>.
+It should not be used alone, but as part of the [PubSubPlugin](/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin).
 
 Note: To use this strategy, you need to manually install the `@google-cloud/pubsub` package:
 

package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx

@@ -37,7 +37,7 @@ the Stripe CLI to test your webhook locally. See the _local development_ section
       }),
     ]
     ````
-    For all the plugin options, see the <DocsLink href="/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions">StripePluginOptions</DocsLink> type.
+    For all the plugin options, see the [StripePluginOptions](/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions) type.
 2. Create a new PaymentMethod in the Admin UI, and select "Stripe payments" as the handler.
 3. Set the webhook secret and API key in the PaymentMethod form.
 

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

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/sentry-plugin/src/types.ts" sourceLine="7" packageName="@vendure/sentry-plugin" />
 
-Configuration options for the <DocsLink href="/reference/core-plugins/sentry-plugin/#sentryplugin">SentryPlugin</DocsLink>.
+Configuration options for the [SentryPlugin](/reference/core-plugins/sentry-plugin/#sentryplugin).
 
 ```ts title="Signature"
 interface SentryPluginOptions {

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

@@ -25,7 +25,7 @@ npm install @vendure/stellate-plugin
 ## Configuration
 
 The plugin is configured via the `StellatePlugin.init()` method. This method accepts an options object
-which defines the Stellate service name and API token, as well as an array of <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink>s which
+which defines the Stellate service name and API token, as well as an array of [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule)s which
 define how the plugin will respond to Vendure events in order to trigger calls to the
 Stellate [Purging API](https://stellate.co/docs/graphql-edge-cache/purging-api).
 
@@ -148,7 +148,7 @@ export const searchProductsDocument = graphql(`
 
 The configuration above only accounts for caching of some of the built-in Vendure entity types. If you have
 custom entity types, you may well want to add them to the Stellate cache. In this case, you'll also need a way to
-purge those entities from the cache when they are updated. This is where the <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink> comes in.
+purge those entities from the cache when they are updated. This is where the [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule) comes in.
 
 Let's imagine that you have built a simple CMS plugin for Vendure which exposes an `Article` entity in your Shop API, and
 you have added this to your Stellate configuration:
@@ -176,7 +176,7 @@ const config: Config = {
 export default config;
 ```
 
-You can then add a custom <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink> to the StellatePlugin configuration:
+You can then add a custom [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule) to the StellatePlugin configuration:
 
 *Example*
 

package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx

@@ -6,7 +6,7 @@ generated: true
 
 Defines a rule that listens for a particular VendureEvent and uses that to
 make calls to the [Stellate Purging API](https://docs.stellate.co/docs/purging-api) via
-the provided <DocsLink href="/reference/core-plugins/stellate-plugin/stellate-service#stellateservice">StellateService</DocsLink> instance.
+the provided [StellateService](/reference/core-plugins/stellate-plugin/stellate-service#stellateservice) instance.
 
 ```ts title="Signature"
 class PurgeRule<Event extends VendureEvent = VendureEvent> {
@@ -44,7 +44,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
 </div>
 <GenerationInfo sourceFile="packages/stellate-plugin/src/purge-rule.ts" sourceLine="13" packageName="@vendure/stellate-plugin" />
 
-Configures a <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink>.
+Configures a [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule).
 
 ```ts title="Signature"
 interface PurgeRuleConfig<Event extends VendureEvent> {
@@ -76,7 +76,7 @@ us to efficiently batch calls to the Stellate Purge API.
 <MemberInfo kind="property" type={`(handlerArgs: {         events: Event[];         stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>;         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>;     }) => void | Promise<void>`}   />
 
 The function to invoke when the specified event is published. This function should use the
-<DocsLink href="/reference/core-plugins/stellate-plugin/stellate-service#stellateservice">StellateService</DocsLink> instance to call the Stellate Purge API.
+[StellateService](/reference/core-plugins/stellate-plugin/stellate-service#stellateservice) instance to call the Stellate Purge API.
 
 
 </div>

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

@@ -34,7 +34,7 @@ see the [Stellate docs](https://docs.stellate.co/docs/purging-api#authentication
 
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a>[]`}   />
 
-An array of <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink> instances which are used to define how the plugin will
+An array of [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule) instances which are used to define how the plugin will
 respond to Vendure events in order to trigger calls to the Stellate Purging API.
 ### defaultBufferTimeMs
 

package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx

@@ -16,7 +16,7 @@ class OtelLogger implements VendureLogger {
     verbose(message: string, context?: string) => void;
 }
 ```
-* Implements: <DocsLink href="/reference/typescript-api/logger/vendure-logger#vendurelogger">`VendureLogger`</DocsLink>
+* Implements: [`VendureLogger`](/reference/typescript-api/logger/vendure-logger#vendurelogger)
 
 
 

package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx

@@ -7,7 +7,7 @@ generated: true
 Allows you to register hooks for a specific method of an instrumented class.
 These hooks allow extra telemetry actions to be performed on the method.
 
-They can then be passed to the <DocsLink href="/reference/core-plugins/telemetry-plugin/#telemetryplugin">TelemetryPlugin</DocsLink> via the <DocsLink href="/reference/core-plugins/telemetry-plugin/telemetry-plugin-options#telemetrypluginoptions">TelemetryPluginOptions</DocsLink>.
+They can then be passed to the [TelemetryPlugin](/reference/core-plugins/telemetry-plugin/#telemetryplugin) via the [TelemetryPluginOptions](/reference/core-plugins/telemetry-plugin/telemetry-plugin-options#telemetrypluginoptions).
 
 *Example*
 

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

@@ -41,7 +41,7 @@ TelemetryPlugin.init({
 This API may change in a future release.
 
 Method hooks allow you to add extra telemetry actions to specific methods.
-To define hooks on a method, use the <DocsLink href="/reference/core-plugins/telemetry-plugin/register-method-hooks#registermethodhooks">registerMethodHooks</DocsLink> function.
+To define hooks on a method, use the [registerMethodHooks](/reference/core-plugins/telemetry-plugin/register-method-hooks#registermethodhooks) function.
 
 *Example*
 

package/docs/reference/dashboard/components/asset-gallery.mdx

@@ -29,7 +29,7 @@ Parameters
 
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-gallery.tsx" sourceLine="83" packageName="@vendure/dashboard" />
 
-Props for the <DocsLink href="/reference/dashboard/components/asset-gallery#assetgallery">AssetGallery</DocsLink> component.
+Props for the [AssetGallery](/reference/dashboard/components/asset-gallery#assetgallery) component.
 
 ```ts title="Signature"
 interface AssetGalleryProps {

package/docs/reference/dashboard/components/asset-picker-dialog.mdx

@@ -17,7 +17,7 @@ Parameters
 
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-picker-dialog.tsx" sourceLine="19" packageName="@vendure/dashboard" />
 
-Props for the <DocsLink href="/reference/dashboard/components/asset-picker-dialog#assetpickerdialog">AssetPickerDialog</DocsLink> component.
+Props for the [AssetPickerDialog](/reference/dashboard/components/asset-picker-dialog#assetpickerdialog) component.
 
 ```ts title="Signature"
 interface AssetPickerDialogProps {

package/docs/reference/dashboard/components/vendure-image.mdx

@@ -37,7 +37,7 @@ Parameters
 
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="59" packageName="@vendure/dashboard" since="3.4.0" />
 
-The props for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
+The props for the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
 
 ```ts title="Signature"
 interface VendureImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
@@ -115,7 +115,7 @@ The ref to the image element.
 </div>
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="13" packageName="@vendure/dashboard" since="3.4.0" />
 
-The type of object that can be used as an asset in the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
+The type of object that can be used as an asset in the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
 
 ```ts title="Signature"
 interface AssetLike {
@@ -153,21 +153,21 @@ interface AssetLike {
 </div>
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="28" packageName="@vendure/dashboard" since="3.4.0" />
 
-The presets that can be used for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
+The presets that can be used for the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
 
 ```ts title="Signature"
 type ImagePreset = 'tiny' | 'thumb' | 'small' | 'medium' | 'large' | 'full' | null
 ```
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="38" packageName="@vendure/dashboard" since="3.4.0" />
 
-The formats that can be used for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
+The formats that can be used for the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
 
 ```ts title="Signature"
 type ImageFormat = 'jpg' | 'jpeg' | 'png' | 'webp' | 'avif' | null
 ```
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="48" packageName="@vendure/dashboard" since="3.4.0" />
 
-The modes that can be used for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
+The modes that can be used for the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
 
 ```ts title="Signature"
 type ImageMode = 'crop' | 'resize' | null

package/docs/reference/dashboard/detail-views/detail-page.mdx

@@ -6,7 +6,7 @@ generated: true
 
 Auto-generates a detail page with a form based on the provided query and mutation documents.
 
-For more control over the layout, you would use the more low-level <DocsLink href="/reference/dashboard/page-layout/page#page">Page</DocsLink> component.
+For more control over the layout, you would use the more low-level [Page](/reference/dashboard/page-layout/page#page) component.
 
 ```ts title="Signature"
 function DetailPage<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>>(props: DetailPageProps<T, C, U>): void
@@ -19,7 +19,7 @@ Parameters
 
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="43" packageName="@vendure/dashboard" since="3.3.0" />
 
-Props to configure the <DocsLink href="/reference/dashboard/detail-views/detail-page#detailpage">DetailPage</DocsLink> component.
+Props to configure the [DetailPage](/reference/dashboard/detail-views/detail-page#detailpage) component.
 
 ```ts title="Signature"
 interface DetailPageProps<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>, EntityField extends keyof ResultOf<T> = DetailEntityPath<T>> {

package/docs/reference/dashboard/detail-views/use-generated-form.mdx

@@ -8,7 +8,7 @@ This hook is used to create a form from a document and an entity.
 It will create a form with the fields defined in the document's input type.
 It will also create a submit handler that will submit the form to the server.
 
-This hook is mostly used internally by the higher-level <DocsLink href="/reference/dashboard/detail-views/use-detail-page#usedetailpage">useDetailPage</DocsLink> hook,
+This hook is mostly used internally by the higher-level [useDetailPage](/reference/dashboard/detail-views/use-detail-page#usedetailpage) hook,
 but can in some cases be useful to use directly.
 
 *Example*

package/docs/reference/dashboard/extensions-api/form-components.mdx

@@ -92,7 +92,7 @@ type DashboardFormComponentProps<TFieldValues extends FieldValues = FieldValues,
 ```
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/form-engine-types.ts" sourceLine="124" packageName="@vendure/dashboard" since="3.4.0" />
 
-Metadata which can be defined on a <DocsLink href="/reference/dashboard/extensions-api/form-components#dashboardformcomponent">DashboardFormComponent</DocsLink> which
+Metadata which can be defined on a [DashboardFormComponent](/reference/dashboard/extensions-api/form-components#dashboardformcomponent) which
 provides additional information about how the dashboard should render the
 component.