Browse Source

fix(docs): Use DocsLink component instead of anchor tags in descriptions

Update typescript-docs-renderer to generate DocsLink components
for {@link} references in description text. The anchor tags inside
MemberInfo components remain unchanged.
David Höck 9 hours ago
parent
commit
eb2c29996a
100 changed files with 42 additions and 574 deletions
  1. 2 6
      docs/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx
  2. 1 5
      docs/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx
  3. 1 5
      docs/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx
  4. 1 5
      docs/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx
  5. 0 4
      docs/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx
  6. 0 4
      docs/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx
  7. 0 4
      docs/docs/reference/admin-ui-api/action-bar/page-location-id.mdx
  8. 1 5
      docs/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx
  9. 0 4
      docs/docs/reference/admin-ui-api/alerts/alert-config.mdx
  10. 1 5
      docs/docs/reference/admin-ui-api/alerts/alert-context.mdx
  11. 1 5
      docs/docs/reference/admin-ui-api/alerts/register-alert.mdx
  12. 1 17
      docs/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx
  13. 1 5
      docs/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx
  14. 0 4
      docs/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx
  15. 0 4
      docs/docs/reference/admin-ui-api/components/chip-component.mdx
  16. 0 4
      docs/docs/reference/admin-ui-api/components/currency-input-component.mdx
  17. 2 6
      docs/docs/reference/admin-ui-api/components/data-table-component.mdx
  18. 1 5
      docs/docs/reference/admin-ui-api/components/data-table2component.mdx
  19. 0 4
      docs/docs/reference/admin-ui-api/components/datetime-picker-component.mdx
  20. 0 4
      docs/docs/reference/admin-ui-api/components/dropdown-component.mdx
  21. 0 4
      docs/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx
  22. 0 4
      docs/docs/reference/admin-ui-api/components/object-tree-component.mdx
  23. 0 4
      docs/docs/reference/admin-ui-api/components/order-state-label-component.mdx
  24. 0 4
      docs/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx
  25. 0 4
      docs/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx
  26. 0 4
      docs/docs/reference/admin-ui-api/components/zone-selector-component.mdx
  27. 1 5
      docs/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx
  28. 1 5
      docs/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx
  29. 0 4
      docs/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx
  30. 1 5
      docs/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx
  31. 1 5
      docs/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx
  32. 1 5
      docs/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx
  33. 1 5
      docs/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx
  34. 1 5
      docs/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx
  35. 1 5
      docs/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx
  36. 2 70
      docs/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx
  37. 0 4
      docs/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx
  38. 2 6
      docs/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx
  39. 0 4
      docs/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx
  40. 2 6
      docs/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx
  41. 1 5
      docs/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx
  42. 0 4
      docs/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx
  43. 1 5
      docs/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx
  44. 0 4
      docs/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx
  45. 0 4
      docs/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx
  46. 0 4
      docs/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx
  47. 0 4
      docs/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx
  48. 1 5
      docs/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx
  49. 1 5
      docs/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx
  50. 1 5
      docs/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx
  51. 1 5
      docs/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx
  52. 1 5
      docs/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx
  53. 1 5
      docs/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx
  54. 0 4
      docs/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx
  55. 0 4
      docs/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx
  56. 0 4
      docs/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx
  57. 1 5
      docs/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx
  58. 0 4
      docs/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx
  59. 0 4
      docs/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx
  60. 0 4
      docs/docs/reference/admin-ui-api/pipes/duration-pipe.mdx
  61. 0 4
      docs/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx
  62. 0 4
      docs/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx
  63. 0 4
      docs/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx
  64. 0 4
      docs/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx
  65. 0 4
      docs/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx
  66. 0 4
      docs/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx
  67. 0 4
      docs/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx
  68. 0 4
      docs/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx
  69. 0 4
      docs/docs/reference/admin-ui-api/react-components/action-bar.mdx
  70. 0 4
      docs/docs/reference/admin-ui-api/react-components/card.mdx
  71. 0 4
      docs/docs/reference/admin-ui-api/react-components/cds-icon.mdx
  72. 0 4
      docs/docs/reference/admin-ui-api/react-components/form-field.mdx
  73. 0 4
      docs/docs/reference/admin-ui-api/react-components/link.mdx
  74. 0 4
      docs/docs/reference/admin-ui-api/react-components/page-block.mdx
  75. 0 4
      docs/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx
  76. 0 4
      docs/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx
  77. 0 4
      docs/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx
  78. 1 5
      docs/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx
  79. 1 5
      docs/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx
  80. 0 4
      docs/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx
  81. 1 5
      docs/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx
  82. 0 4
      docs/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx
  83. 0 4
      docs/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx
  84. 0 4
      docs/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx
  85. 0 4
      docs/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx
  86. 0 4
      docs/docs/reference/admin-ui-api/react-hooks/use-injector.mdx
  87. 0 4
      docs/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx
  88. 0 4
      docs/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx
  89. 0 4
      docs/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx
  90. 0 4
      docs/docs/reference/admin-ui-api/react-hooks/use-query.mdx
  91. 0 4
      docs/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx
  92. 0 4
      docs/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx
  93. 0 4
      docs/docs/reference/admin-ui-api/routes/register-route-component-options.mdx
  94. 0 4
      docs/docs/reference/admin-ui-api/routes/register-route-component.mdx
  95. 1 9
      docs/docs/reference/admin-ui-api/services/data-service.mdx
  96. 1 17
      docs/docs/reference/admin-ui-api/services/modal-service.mdx
  97. 0 12
      docs/docs/reference/admin-ui-api/services/notification-service.mdx
  98. 0 4
      docs/docs/reference/admin-ui-api/tabs/page-tab-config.mdx
  99. 0 4
      docs/docs/reference/admin-ui-api/tabs/register-page-tab.mdx
  100. 1 37
      docs/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx

+ 2 - 6
docs/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx

@@ -2,14 +2,10 @@
 title: "ActionBarContext"
 generated: true
 ---
-
-
-## ActionBarContext
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="90" packageName="@vendure/admin-ui" />
 
-Providers & data available to the `onClick` & `buttonState` functions of an <a href='/reference/admin-ui-api/action-bar/action-bar-item#actionbaritem'>ActionBarItem</a>,
-<a href='/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item#actionbardropdownmenuitem'>ActionBarDropdownMenuItem</a> or <a href='/reference/admin-ui-api/nav-menu/nav-menu-item#navmenuitem'>NavMenuItem</a>.
+Providers & data available to the `onClick` & `buttonState` functions of an <DocsLink href="/reference/admin-ui-api/action-bar/action-bar-item#actionbaritem">ActionBarItem</DocsLink>,
+<DocsLink href="/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item#actionbardropdownmenuitem">ActionBarDropdownMenuItem</DocsLink> or <DocsLink href="/reference/admin-ui-api/nav-menu/nav-menu-item#navmenuitem">NavMenuItem</DocsLink>.
 
 ```ts title="Signature"
 interface ActionBarContext {

+ 1 - 5
docs/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx

@@ -2,10 +2,6 @@
 title: "ActionBarDropdownMenuItem"
 generated: true
 ---
-
-
-## ActionBarDropdownMenuItem
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="227" packageName="@vendure/admin-ui" since="2.2.0" />
 
 A dropdown menu item in the ActionBar area at the top of one of the list or detail views.
@@ -75,7 +71,7 @@ set.
 <MemberInfo kind="property" type={`string | string[]`}   />
 
 Control the display of this item based on the user permissions. Note: if you attempt to pass a
-<a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a> object, you will get a compilation error. Instead, pass the plain
+<DocsLink href="/reference/typescript-api/auth/permission-definition#permissiondefinition">PermissionDefinition</DocsLink> object, you will get a compilation error. Instead, pass the plain
 string version. For example, if the permission is defined as:
 
 ```ts

+ 1 - 5
docs/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx

@@ -2,10 +2,6 @@
 title: "ActionBarItem"
 generated: true
 ---
-
-
-## ActionBarItem
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="158" packageName="@vendure/admin-ui" />
 
 A button in the ActionBar area at the top of one of the list or detail views.
@@ -87,7 +83,7 @@ set.
 <MemberInfo kind="property" type={`string | string[]`}   />
 
 Control the display of this item based on the user permissions. Note: if you attempt to pass a
-<a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a> object, you will get a compilation error. Instead, pass the plain
+<DocsLink href="/reference/typescript-api/auth/permission-definition#permissiondefinition">PermissionDefinition</DocsLink> object, you will get a compilation error. Instead, pass the plain
 string version. For example, if the permission is defined as:
 
 ```ts

+ 1 - 5
docs/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx

@@ -2,14 +2,10 @@
 title: "ActionBarLocationId"
 generated: true
 ---
-
-
-## ActionBarLocationId
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="107" packageName="@vendure/admin-ui" />
 
 The valid locationIds for registering action bar items. For a list of
-values, see <a href='/reference/admin-ui-api/action-bar/page-location-id#pagelocationid'>PageLocationId</a>.
+values, see <DocsLink href="/reference/admin-ui-api/action-bar/page-location-id#pagelocationid">PageLocationId</DocsLink>.
 
 ```ts title="Signature"
 type ActionBarLocationId = PageLocationId

+ 0 - 4
docs/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx

@@ -2,10 +2,6 @@
 title: "AddActionBarDropdownMenuItem"
 generated: true
 ---
-
-
-## addActionBarDropdownMenuItem
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-action-bar-dropdown-menu-item.ts" sourceLine="27" packageName="@vendure/admin-ui" since="2.2.0" />
 
 Adds a dropdown menu item to the ActionBar at the top right of each list or detail view. The locationId can

+ 0 - 4
docs/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx

@@ -2,10 +2,6 @@
 title: "AddActionBarItem"
 generated: true
 ---
-
-
-## addActionBarItem
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-action-bar-item.ts" sourceLine="23" packageName="@vendure/admin-ui" />
 
 Adds a button to the ActionBar at the top right of each list or detail view. The locationId can

+ 0 - 4
docs/docs/reference/admin-ui-api/action-bar/page-location-id.mdx

@@ -2,10 +2,6 @@
 title: "PageLocationId"
 generated: true
 ---
-
-
-## PageLocationId
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="52" packageName="@vendure/admin-ui" />
 
 The valid locationIds for registering action bar items or tabs.

+ 1 - 5
docs/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx

@@ -2,13 +2,9 @@
 title: "RouterLinkDefinition"
 generated: true
 ---
-
-
-## RouterLinkDefinition
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="289" packageName="@vendure/admin-ui" />
 
-A function which returns the router link for an <a href='/reference/admin-ui-api/action-bar/action-bar-item#actionbaritem'>ActionBarItem</a> or <a href='/reference/admin-ui-api/nav-menu/nav-menu-item#navmenuitem'>NavMenuItem</a>.
+A function which returns the router link for an <DocsLink href="/reference/admin-ui-api/action-bar/action-bar-item#actionbaritem">ActionBarItem</DocsLink> or <DocsLink href="/reference/admin-ui-api/nav-menu/nav-menu-item#navmenuitem">NavMenuItem</DocsLink>.
 
 ```ts title="Signature"
 type RouterLinkDefinition = ((route: ActivatedRoute, context: ActionBarContext) => any[]) | any[]

+ 0 - 4
docs/docs/reference/admin-ui-api/alerts/alert-config.mdx

@@ -2,10 +2,6 @@
 title: "AlertConfig"
 generated: true
 ---
-
-
-## AlertConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/alerts/alerts.service.ts" sourceLine="63" packageName="@vendure/admin-ui" since="2.2.0" />
 
 A configuration object for an Admin UI alert.

+ 1 - 5
docs/docs/reference/admin-ui-api/alerts/alert-context.mdx

@@ -2,14 +2,10 @@
 title: "AlertContext"
 generated: true
 ---
-
-
-## AlertContext
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/alerts/alerts.service.ts" sourceLine="29" packageName="@vendure/admin-ui" since="2.2.0" />
 
 The context object which is passed to the `check`, `isAlert`, `label` and `action` functions of an
-<a href='/reference/admin-ui-api/alerts/alert-config#alertconfig'>AlertConfig</a> object.
+<DocsLink href="/reference/admin-ui-api/alerts/alert-config#alertconfig">AlertConfig</DocsLink> object.
 
 ```ts title="Signature"
 interface AlertContext {

+ 1 - 5
docs/docs/reference/admin-ui-api/alerts/register-alert.mdx

@@ -2,14 +2,10 @@
 title: "RegisterAlert"
 generated: true
 ---
-
-
-## registerAlert
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-alert.ts" sourceLine="12" packageName="@vendure/admin-ui" since="2.2.0" />
 
 Registers an alert which can be displayed in the Admin UI alert dropdown in the top bar.
-The alert is configured using the <a href='/reference/admin-ui-api/alerts/alert-config#alertconfig'>AlertConfig</a> object.
+The alert is configured using the <DocsLink href="/reference/admin-ui-api/alerts/alert-config#alertconfig">AlertConfig</DocsLink> object.
 
 ```ts title="Signature"
 function registerAlert(config: AlertConfig): void

+ 1 - 17
docs/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx

@@ -2,15 +2,11 @@
 title: "BulkAction"
 generated: true
 ---
-
-
-## BulkAction
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/bulk-action-registry/bulk-action-types.ts" sourceLine="99" packageName="@vendure/admin-ui" since="1.8.0" />
 
 Configures a bulk action which can be performed on all selected items in a list view.
 
-For a full example, see the <a href='/reference/admin-ui-api/bulk-actions/register-bulk-action#registerbulkaction'>registerBulkAction</a> docs.
+For a full example, see the <DocsLink href="/reference/admin-ui-api/bulk-actions/register-bulk-action#registerbulkaction">registerBulkAction</DocsLink> docs.
 
 ```ts title="Signature"
 interface BulkAction<ItemType = any, ComponentType = any> {
@@ -116,10 +112,6 @@ registerBulkAction({
 
 
 </div>
-
-
-## BulkActionLocationId
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/bulk-action-registry/bulk-action-types.ts" sourceLine="12" packageName="@vendure/admin-ui" since="1.8.0" />
 
 A valid location of a list view that supports the bulk actions API.
@@ -146,10 +138,6 @@ type BulkActionLocationId = | 'product-list'
     | 'zone-members-list'
     | string
 ```
-
-
-## BulkActionFunctionContext
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/bulk-action-registry/bulk-action-types.ts" sourceLine="43" packageName="@vendure/admin-ui" since="1.8.0" />
 
 This is the argument which gets passed to the `getTranslationVars` and `isVisible` functions
@@ -193,10 +181,6 @@ to get service instances which might be needed in the click handler.
 
 
 </div>
-
-
-## BulkActionClickContext
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/bulk-action-registry/bulk-action-types.ts" sourceLine="74" packageName="@vendure/admin-ui" since="1.8.0" />
 
 This is the argument which gets passed to the `onClick` function of a BulkAction.

+ 1 - 5
docs/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx

@@ -2,13 +2,9 @@
 title: "RegisterBulkAction"
 generated: true
 ---
-
-
-## registerBulkAction
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-bulk-action.ts" sourceLine="52" packageName="@vendure/admin-ui" since="1.8.0" />
 
-Registers a custom <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkaction'>BulkAction</a> which can be invoked from the bulk action menu
+Registers a custom <DocsLink href="/reference/admin-ui-api/bulk-actions/bulk-action#bulkaction">BulkAction</DocsLink> which can be invoked from the bulk action menu
 of any supported list view.
 
 This allows you to provide custom functionality that can operate on any of the selected

+ 0 - 4
docs/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx

@@ -2,10 +2,6 @@
 title: "AssetPickerDialogComponent"
 generated: true
 ---
-
-
-## AssetPickerDialogComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/asset-picker-dialog/asset-picker-dialog.component.ts" sourceLine="51" packageName="@vendure/admin-ui" />
 
 A dialog which allows the creation and selection of assets.

+ 0 - 4
docs/docs/reference/admin-ui-api/components/chip-component.mdx

@@ -2,10 +2,6 @@
 title: "ChipComponent"
 generated: true
 ---
-
-
-## ChipComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/chip/chip.component.ts" sourceLine="16" packageName="@vendure/admin-ui" />
 
 A chip component for displaying a label with an optional action icon.

+ 0 - 4
docs/docs/reference/admin-ui-api/components/currency-input-component.mdx

@@ -2,10 +2,6 @@
 title: "CurrencyInputComponent"
 generated: true
 ---
-
-
-## CurrencyInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/currency-input/currency-input.component.ts" sourceLine="33" packageName="@vendure/admin-ui" />
 
 A form input control which displays currency in decimal format, whilst working

+ 2 - 6
docs/docs/reference/admin-ui-api/components/data-table-component.mdx

@@ -2,16 +2,12 @@
 title: "DataTableComponent"
 generated: true
 ---
-
-
-## DataTableComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table/data-table.component.ts" sourceLine="86" packageName="@vendure/admin-ui" />
 
 A table for displaying PaginatedList results. It is designed to be used inside components which
-extend the <a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a> class.
+extend the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent">BaseListComponent</DocsLink> class.
 
-**Deprecated** This component is deprecated. Use the <a href='/reference/admin-ui-api/components/data-table2component#datatable2component'>DataTable2Component</a> instead.
+**Deprecated** This component is deprecated. Use the <DocsLink href="/reference/admin-ui-api/components/data-table2component#datatable2component">DataTable2Component</DocsLink> instead.
 
 *Example*
 

+ 1 - 5
docs/docs/reference/admin-ui-api/components/data-table2component.mdx

@@ -2,14 +2,10 @@
 title: "DataTable2Component"
 generated: true
 ---
-
-
-## DataTable2Component
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table-2/data-table2.component.ts" sourceLine="101" packageName="@vendure/admin-ui" />
 
 A table for displaying PaginatedList results. It is designed to be used inside components which
-extend the <a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a> or <a href='/reference/admin-ui-api/list-detail-views/typed-base-list-component#typedbaselistcomponent'>TypedBaseListComponent</a> class.
+extend the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent">BaseListComponent</DocsLink> or <DocsLink href="/reference/admin-ui-api/list-detail-views/typed-base-list-component#typedbaselistcomponent">TypedBaseListComponent</DocsLink> class.
 
 *Example*
 

+ 0 - 4
docs/docs/reference/admin-ui-api/components/datetime-picker-component.mdx

@@ -2,10 +2,6 @@
 title: "DatetimePickerComponent"
 generated: true
 ---
-
-
-## DatetimePickerComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/datetime-picker/datetime-picker.component.ts" sourceLine="39" packageName="@vendure/admin-ui" />
 
 A form input for selecting datetime values.

+ 0 - 4
docs/docs/reference/admin-ui-api/components/dropdown-component.mdx

@@ -2,10 +2,6 @@
 title: "DropdownComponent"
 generated: true
 ---
-
-
-## DropdownComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/dropdown/dropdown.component.ts" sourceLine="28" packageName="@vendure/admin-ui" />
 
 Used for building dropdown menus.

+ 0 - 4
docs/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx

@@ -2,10 +2,6 @@
 title: "FacetValueSelectorComponent"
 generated: true
 ---
-
-
-## FacetValueSelectorComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/facet-value-selector/facet-value-selector.component.ts" sourceLine="34" packageName="@vendure/admin-ui" />
 
 A form control for selecting facet values.

+ 0 - 4
docs/docs/reference/admin-ui-api/components/object-tree-component.mdx

@@ -2,10 +2,6 @@
 title: "ObjectTreeComponent"
 generated: true
 ---
-
-
-## ObjectTreeComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/object-tree/object-tree.component.ts" sourceLine="22" packageName="@vendure/admin-ui" />
 
 This component displays a plain JavaScript object as an expandable tree.

+ 0 - 4
docs/docs/reference/admin-ui-api/components/order-state-label-component.mdx

@@ -2,10 +2,6 @@
 title: "OrderStateLabelComponent"
 generated: true
 ---
-
-
-## OrderStateLabelComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/order-state-label/order-state-label.component.ts" sourceLine="13" packageName="@vendure/admin-ui" />
 
 Displays the state of an order in a colored chip.

+ 0 - 4
docs/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx

@@ -2,10 +2,6 @@
 title: "ProductVariantSelectorComponent"
 generated: true
 ---
-
-
-## ProductVariantSelectorComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/product-variant-selector/product-variant-selector.component.ts" sourceLine="21" packageName="@vendure/admin-ui" />
 
 A component for selecting product variants via an autocomplete-style select input.

+ 0 - 4
docs/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx

@@ -2,10 +2,6 @@
 title: "RichTextEditorComponent"
 generated: true
 ---
-
-
-## RichTextEditorComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/rich-text-editor/rich-text-editor.component.ts" sourceLine="32" packageName="@vendure/admin-ui" />
 
 A rich text (HTML) editor based on Prosemirror (https://prosemirror.net/)

+ 0 - 4
docs/docs/reference/admin-ui-api/components/zone-selector-component.mdx

@@ -2,10 +2,6 @@
 title: "ZoneSelectorComponent"
 generated: true
 ---
-
-
-## ZoneSelectorComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/zone-selector/zone-selector.component.ts" sourceLine="40" packageName="@vendure/admin-ui" />
 
 A form control for selecting zones.

+ 1 - 5
docs/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx

@@ -2,13 +2,9 @@
 title: "CustomDetailComponentConfig"
 generated: true
 ---
-
-
-## CustomDetailComponentConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-detail-component/custom-detail-component-types.ts" sourceLine="25" packageName="@vendure/admin-ui" />
 
-Configures a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a> to be placed in the given location.
+Configures a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink> to be placed in the given location.
 
 ```ts title="Signature"
 interface CustomDetailComponentConfig {

+ 1 - 5
docs/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx

@@ -2,13 +2,9 @@
 title: "CustomDetailComponentLocationId"
 generated: true
 ---
-
-
-## CustomDetailComponentLocationId
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="115" packageName="@vendure/admin-ui" />
 
-The valid locations for embedding a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a>.
+The valid locations for embedding a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink>.
 
 ```ts title="Signature"
 type CustomDetailComponentLocationId = | 'administrator-profile'

+ 0 - 4
docs/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx

@@ -2,10 +2,6 @@
 title: "CustomDetailComponent"
 generated: true
 ---
-
-
-## CustomDetailComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-detail-component/custom-detail-component-types.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 CustomDetailComponents allow any arbitrary Angular components to be embedded in entity detail

+ 1 - 5
docs/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx

@@ -2,13 +2,9 @@
 title: "RegisterCustomDetailComponent"
 generated: true
 ---
-
-
-## registerCustomDetailComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-custom-detail-component.ts" sourceLine="57" packageName="@vendure/admin-ui" />
 
-Registers a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a> to be placed in a given location. This allows you
+Registers a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink> to be placed in a given location. This allows you
 to embed any type of custom Angular component in the entity detail pages of the Admin UI.
 
 *Example*

+ 1 - 5
docs/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx

@@ -2,13 +2,9 @@
 title: "CustomerHistoryEntryComponent"
 generated: true
 ---
-
-
-## CustomerHistoryEntryComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="64" packageName="@vendure/admin-ui" since="1.9.0" />
 
-Used to implement a <a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a> which requires access to the Customer object.
+Used to implement a <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent">HistoryEntryComponent</DocsLink> which requires access to the Customer object.
 
 ```ts title="Signature"
 interface CustomerHistoryEntryComponent extends HistoryEntryComponent {

+ 1 - 5
docs/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx

@@ -2,15 +2,11 @@
 title: "HistoryEntryComponent"
 generated: true
 ---
-
-
-## HistoryEntryComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="16" packageName="@vendure/admin-ui" since="1.9.0" />
 
 This interface should be implemented by components intended to display a history entry in the
 Order or Customer history timeline. If the component needs access to the Order or Customer object itself,
-you should implement <a href='/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component#orderhistoryentrycomponent'>OrderHistoryEntryComponent</a> or <a href='/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component#customerhistoryentrycomponent'>CustomerHistoryEntryComponent</a> respectively.
+you should implement <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component#orderhistoryentrycomponent">OrderHistoryEntryComponent</DocsLink> or <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component#customerhistoryentrycomponent">CustomerHistoryEntryComponent</DocsLink> respectively.
 
 ```ts title="Signature"
 interface HistoryEntryComponent {

+ 1 - 5
docs/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx

@@ -2,13 +2,9 @@
 title: "HistoryEntryConfig"
 generated: true
 ---
-
-
-## HistoryEntryConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="75" packageName="@vendure/admin-ui" since="1.9.0" />
 
-Configuration for registering a custom <a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a>.
+Configuration for registering a custom <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent">HistoryEntryComponent</DocsLink>.
 
 ```ts title="Signature"
 interface HistoryEntryConfig {

+ 1 - 5
docs/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx

@@ -2,13 +2,9 @@
 title: "OrderHistoryEntryComponent"
 generated: true
 ---
-
-
-## OrderHistoryEntryComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="53" packageName="@vendure/admin-ui" since="1.9.0" />
 
-Used to implement a <a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a> which requires access to the Order object.
+Used to implement a <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent">HistoryEntryComponent</DocsLink> which requires access to the Order object.
 
 ```ts title="Signature"
 interface OrderHistoryEntryComponent extends HistoryEntryComponent {

+ 1 - 5
docs/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx

@@ -2,13 +2,9 @@
 title: "RegisterHistoryEntryComponent"
 generated: true
 ---
-
-
-## registerHistoryEntryComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-history-entry-component.ts" sourceLine="68" packageName="@vendure/admin-ui" since="1.9.0" />
 
-Registers a <a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a> for displaying history entries in the Order/Customer
+Registers a <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent">HistoryEntryComponent</DocsLink> for displaying history entries in the Order/Customer
 history timeline.
 
 *Example*

+ 2 - 70
docs/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx

@@ -2,10 +2,6 @@
 title: "Default Inputs"
 generated: true
 ---
-
-
-## BooleanFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/boolean-form-input/boolean-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 A checkbox input. The default input component for `boolean` fields.
@@ -47,10 +43,6 @@ class BooleanFormInputComponent implements FormInputComponent {
 
 
 </div>
-
-
-## HtmlEditorFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/code-editor-form-input/html-editor-form-input.component.ts" sourceLine="23" packageName="@vendure/admin-ui" />
 
 A JSON editor input with syntax highlighting and error detection. Works well
@@ -90,10 +82,6 @@ class HtmlEditorFormInputComponent extends BaseCodeEditorFormInputComponent impl
 
 
 </div>
-
-
-## JsonEditorFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/code-editor-form-input/json-editor-form-input.component.ts" sourceLine="33" packageName="@vendure/admin-ui" />
 
 A JSON editor input with syntax highlighting and error detection. Works well
@@ -133,10 +121,6 @@ class JsonEditorFormInputComponent extends BaseCodeEditorFormInputComponent impl
 
 
 </div>
-
-
-## CombinationModeFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/combination-mode-form-input/combination-mode-form-input.component.ts" sourceLine="17" packageName="@vendure/admin-ui" />
 
 A special input used to display the "Combination mode" AND/OR toggle.
@@ -208,10 +192,6 @@ class CombinationModeFormInputComponent implements FormInputComponent, OnInit {
 
 
 </div>
-
-
-## CurrencyFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/currency-form-input/currency-form-input.component.ts" sourceLine="17" packageName="@vendure/admin-ui" />
 
 An input for monetary values. Should be used with `int` type fields.
@@ -265,10 +245,6 @@ class CurrencyFormInputComponent implements FormInputComponent {
 
 
 </div>
-
-
-## CustomerGroupFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/customer-group-form-input/customer-group-form-input.component.ts" sourceLine="20" packageName="@vendure/admin-ui" />
 
 Allows the selection of a Customer via an autocomplete select input.
@@ -341,10 +317,6 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
 
 
 </div>
-
-
-## DateFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/date-form-input/date-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 Allows selection of a datetime. Default input for `datetime` type fields.
@@ -404,10 +376,6 @@ class DateFormInputComponent implements FormInputComponent {
 
 
 </div>
-
-
-## FacetValueFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/facet-value-form-input/facet-value-form-input.component.ts" sourceLine="16" packageName="@vendure/admin-ui" />
 
 Allows the selection of multiple FacetValues via an autocomplete select input.
@@ -469,10 +437,6 @@ class FacetValueFormInputComponent implements FormInputComponent {
 
 
 </div>
-
-
-## NumberFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/number-form-input/number-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 Displays a number input. Default input for `int` and `float` type fields.
@@ -544,10 +508,6 @@ class NumberFormInputComponent implements FormInputComponent {
 
 
 </div>
-
-
-## PasswordFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/password-form-input/password-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 Displays a password text input. Should be used with `string` type fields.
@@ -589,10 +549,6 @@ class PasswordFormInputComponent implements FormInputComponent {
 
 
 </div>
-
-
-## ProductSelectorFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/product-selector-form-input/product-selector-form-input.component.ts" sourceLine="20" packageName="@vendure/admin-ui" />
 
 Allows the selection of multiple ProductVariants via an autocomplete select input.
@@ -671,15 +627,11 @@ class ProductSelectorFormInputComponent implements FormInputComponent, OnInit {
 
 
 </div>
-
-
-## RelationFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/relation-form-input/relation-form-input.component.ts" sourceLine="17" packageName="@vendure/admin-ui" />
 
 The default input component for `relation` type custom fields. Allows the selection
 of a ProductVariant, Product, Customer or Asset. For other entity types, a custom
-implementation will need to be defined. See <a href='/reference/admin-ui-api/custom-input-components/register-form-input-component#registerforminputcomponent'>registerFormInputComponent</a>.
+implementation will need to be defined. See <DocsLink href="/reference/admin-ui-api/custom-input-components/register-form-input-component#registerforminputcomponent">registerFormInputComponent</DocsLink>.
 
 ```ts title="Signature"
 class RelationFormInputComponent implements FormInputComponent {
@@ -718,13 +670,9 @@ class RelationFormInputComponent implements FormInputComponent {
 
 
 </div>
-
-
-## RichTextFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/rich-text-form-input/rich-text-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
-Uses the <a href='/reference/admin-ui-api/components/rich-text-editor-component#richtexteditorcomponent'>RichTextEditorComponent</a> as in input for `text` type fields.
+Uses the <DocsLink href="/reference/admin-ui-api/components/rich-text-editor-component#richtexteditorcomponent">RichTextEditorComponent</DocsLink> as in input for `text` type fields.
 
 ```ts title="Signature"
 class RichTextFormInputComponent implements FormInputComponent {
@@ -763,10 +711,6 @@ class RichTextFormInputComponent implements FormInputComponent {
 
 
 </div>
-
-
-## SelectFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/select-form-input/select-form-input.component.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 
 Uses a select input to allow the selection of a string value. Should be used with
@@ -839,10 +783,6 @@ class SelectFormInputComponent implements FormInputComponent, OnInit {
 
 
 </div>
-
-
-## StructFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/struct-form-input/struct-form-input.component.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 
 A checkbox input. The default input component for `boolean` fields.
@@ -923,10 +863,6 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
 
 
 </div>
-
-
-## TextFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/text-form-input/text-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 Uses a regular text form input. This is the default input for `string` and `localeString` type fields.
@@ -980,10 +916,6 @@ class TextFormInputComponent implements FormInputComponent {
 
 
 </div>
-
-
-## TextareaFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/textarea-form-input/textarea-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 Uses textarea form input. This is the default input for `text` type fields.

+ 0 - 4
docs/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx

@@ -2,10 +2,6 @@
 title: "FormInputComponent"
 generated: true
 ---
-
-
-## FormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="11" packageName="@vendure/admin-ui" />
 
 This interface should be implemented by any component being used as a custom input. For example,

+ 2 - 6
docs/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx

@@ -2,14 +2,10 @@
 title: "RegisterFormInputComponent"
 generated: true
 ---
-
-
-## registerFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-form-input-component.ts" sourceLine="53" packageName="@vendure/admin-ui" />
 
 Registers a custom FormInputComponent which can be used to control the argument inputs
-of a <a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a> (e.g. CollectionFilter, ShippingMethod etc.) or for
+of a <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">ConfigurableOperationDef</DocsLink> (e.g. CollectionFilter, ShippingMethod etc.) or for
 a custom field.
 
 *Example*
@@ -45,7 +41,7 @@ const config: VendureConfig = {
 }
 ```
 
-or with an argument of a <a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a>:
+or with an argument of a <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">ConfigurableOperationDef</DocsLink>:
 
 *Example*
 

+ 0 - 4
docs/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx

@@ -2,10 +2,6 @@
 title: "CustomColumnComponent"
 generated: true
 ---
-
-
-## CustomColumnComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table-2/data-table-custom-component.service.ts" sourceLine="44" packageName="@vendure/admin-ui" />
 
 Components which are to be used to render custom cells in a data table should implement this interface.

+ 2 - 6
docs/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx

@@ -2,13 +2,9 @@
 title: "DataTableComponentConfig"
 generated: true
 ---
-
-
-## DataTableComponentConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table-2/data-table-custom-component.service.ts" sourceLine="54" packageName="@vendure/admin-ui" />
 
-Configures a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a> to be placed in the given location.
+Configures a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink> to be placed in the given location.
 
 ```ts title="Signature"
 interface DataTableComponentConfig {
@@ -36,7 +32,7 @@ The column in the table where the custom component should be placed.
 <MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a>>`}   />
 
 The component to render in the table cell. This component should implement the
-<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a> interface.
+<DocsLink href="/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent">CustomColumnComponent</DocsLink> interface.
 ### providers
 
 <MemberInfo kind="property" type={`Provider[]`}   />

+ 1 - 5
docs/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx

@@ -2,14 +2,10 @@
 title: "RegisterDataTableComponent"
 generated: true
 ---
-
-
-## registerDataTableComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-data-table-component.ts" sourceLine="45" packageName="@vendure/admin-ui" />
 
 Allows you to override the default component used to render the data of a particular column in a DataTable.
-The component should implement the <a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a> interface. The tableId and columnId can
+The component should implement the <DocsLink href="/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent">CustomColumnComponent</DocsLink> interface. The tableId and columnId can
 be determined by pressing `ctrl + u` when running the Admin UI in dev mode.
 
 *Example*

+ 0 - 4
docs/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx

@@ -2,10 +2,6 @@
 title: "DashboardWidgetConfig"
 generated: true
 ---
-
-
-## DashboardWidgetConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/dashboard-widget/dashboard-widget-types.ts" sourceLine="11" packageName="@vendure/admin-ui" />
 
 A configuration object for a dashboard widget.

+ 1 - 5
docs/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx

@@ -2,14 +2,10 @@
 title: "RegisterDashboardWidget"
 generated: true
 ---
-
-
-## registerDashboardWidget
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-dashboard-widget.ts" sourceLine="16" packageName="@vendure/admin-ui" />
 
 Registers a dashboard widget. Once registered, the widget can be set as part of the default
-(using <a href='/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout#setdashboardwidgetlayout'>setDashboardWidgetLayout</a>).
+(using <DocsLink href="/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout#setdashboardwidgetlayout">setDashboardWidgetLayout</DocsLink>).
 
 ```ts title="Signature"
 function registerDashboardWidget(id: string, config: DashboardWidgetConfig): void

+ 0 - 4
docs/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx

@@ -2,10 +2,6 @@
 title: "SetDashboardWidgetLayout"
 generated: true
 ---
-
-
-## setDashboardWidgetLayout
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-dashboard-widget.ts" sourceLine="31" packageName="@vendure/admin-ui" />
 
 Sets the default widget layout for the Admin UI dashboard.

+ 0 - 4
docs/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx

@@ -2,10 +2,6 @@
 title: "WidgetLayoutDefinition"
 generated: true
 ---
-
-
-## WidgetLayoutDefinition
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/dashboard-widget/dashboard-widget-types.ts" sourceLine="51" packageName="@vendure/admin-ui" />
 
 A configuration object for the default dashboard widget layout.

+ 0 - 4
docs/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx

@@ -2,10 +2,6 @@
 title: "IfMultichannelDirective"
 generated: true
 ---
-
-
-## IfMultichannelDirective
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/directives/if-multichannel.directive.ts" sourceLine="21" packageName="@vendure/admin-ui" />
 
 Structural directive that displays the given element if the Vendure instance has multiple channels

+ 0 - 4
docs/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx

@@ -2,10 +2,6 @@
 title: "IfPermissionsDirective"
 generated: true
 ---
-
-
-## IfPermissionsDirective
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/directives/if-permissions.directive.ts" sourceLine="26" packageName="@vendure/admin-ui" />
 
 Conditionally shows/hides templates based on the current active user having the specified permission.

+ 1 - 5
docs/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx

@@ -2,14 +2,10 @@
 title: "BaseDetailComponent"
 generated: true
 ---
-
-
-## BaseDetailComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="57" packageName="@vendure/admin-ui" />
 
 A base class for entity detail views. It should be used in conjunction with the
-<a href='/reference/admin-ui-api/list-detail-views/base-entity-resolver#baseentityresolver'>BaseEntityResolver</a>.
+<DocsLink href="/reference/admin-ui-api/list-detail-views/base-entity-resolver#baseentityresolver">BaseEntityResolver</DocsLink>.
 
 *Example*
 

+ 1 - 5
docs/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx

@@ -2,15 +2,11 @@
 title: "BaseEntityResolver"
 generated: true
 ---
-
-
-## BaseEntityResolver
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-entity-resolver.ts" sourceLine="55" packageName="@vendure/admin-ui" />
 
 A base resolver for an entity detail route. Resolves to an observable of the given entity, or a "blank"
 version if the route id equals "create". Should be used together with details views which extend the
-<a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a>.
+<DocsLink href="/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent">BaseDetailComponent</DocsLink>.
 
 *Example*
 

+ 1 - 5
docs/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx

@@ -2,16 +2,12 @@
 title: "BaseListComponent"
 generated: true
 ---
-
-
-## BaseListComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-list.component.ts" sourceLine="43" packageName="@vendure/admin-ui" />
 
 This is a base class which implements the logic required to fetch and manipulate
 a list of data from a query which returns a PaginatedList type.
 
-It is normally used in combination with the <a href='/reference/admin-ui-api/components/data-table2component#datatable2component'>DataTable2Component</a>.
+It is normally used in combination with the <DocsLink href="/reference/admin-ui-api/components/data-table2component#datatable2component">DataTable2Component</DocsLink>.
 
 ```ts title="Signature"
 class BaseListComponent<ResultType, ItemType, VariableType extends Record<string, any> = any> implements OnInit, OnDestroy {

+ 1 - 5
docs/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx

@@ -2,13 +2,9 @@
 title: "DetailComponentWithResolver"
 generated: true
 ---
-
-
-## detailComponentWithResolver
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="256" packageName="@vendure/admin-ui" />
 
-A helper function for creating tabs that point to a <a href='/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent'>TypedBaseDetailComponent</a>. This takes
+A helper function for creating tabs that point to a <DocsLink href="/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent">TypedBaseDetailComponent</DocsLink>. This takes
 care of the route resolver parts so that the detail component automatically has access to the
 correct resolved detail data.
 

+ 1 - 5
docs/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx

@@ -2,13 +2,9 @@
 title: "TypedBaseDetailComponent"
 generated: true
 ---
-
-
-## TypedBaseDetailComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="186" packageName="@vendure/admin-ui" />
 
-A version of the <a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a> which is designed to be used with a
+A version of the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent">BaseDetailComponent</DocsLink> which is designed to be used with a
 [TypedDocumentNode](https://the-guild.dev/graphql/codegen/plugins/typescript/typed-document-node).
 
 ```ts title="Signature"

+ 1 - 5
docs/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx

@@ -2,13 +2,9 @@
 title: "TypedBaseListComponent"
 generated: true
 ---
-
-
-## TypedBaseListComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-list.component.ts" sourceLine="217" packageName="@vendure/admin-ui" />
 
-A version of the <a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a> which is designed to be used with a
+A version of the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent">BaseListComponent</DocsLink> which is designed to be used with a
 [TypedDocumentNode](https://the-guild.dev/graphql/codegen/plugins/typescript/typed-document-node).
 
 ```ts title="Signature"

+ 0 - 4
docs/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx

@@ -2,10 +2,6 @@
 title: "AddNavMenuItem"
 generated: true
 ---
-
-
-## addNavMenuItem
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-nav-menu-item.ts" sourceLine="66" packageName="@vendure/admin-ui" />
 
 Add a menu item to an existing section specified by `sectionId`. The id of the section

+ 0 - 4
docs/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx

@@ -2,10 +2,6 @@
 title: "AddNavMenuSection"
 generated: true
 ---
-
-
-## addNavMenuSection
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-nav-menu-item.ts" sourceLine="30" packageName="@vendure/admin-ui" />
 
 Add a section to the main nav menu. Providing the `before` argument will

+ 0 - 4
docs/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx

@@ -2,10 +2,6 @@
 title: "NavMenuItem"
 generated: true
 ---
-
-
-## NavMenuItem
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="37" packageName="@vendure/admin-ui" />
 
 A NavMenuItem is a menu item in the main (left-hand side) nav

+ 1 - 5
docs/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx

@@ -2,10 +2,6 @@
 title: "NavMenuSection"
 generated: true
 ---
-
-
-## NavMenuSection
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="57" packageName="@vendure/admin-ui" />
 
 A NavMenuSection is a grouping of links in the main
@@ -56,7 +52,7 @@ interface NavMenuSection {
 <MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`}   />
 
 Control the display of this item based on the user permissions. Note: if you attempt to pass a
-<a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a> object, you will get a compilation error. Instead, pass the plain
+<DocsLink href="/reference/typescript-api/auth/permission-definition#permissiondefinition">PermissionDefinition</DocsLink> object, you will get a compilation error. Instead, pass the plain
 string version. For example, if the permission is defined as:
 ```ts
 export const MyPermission = new PermissionDefinition('ProductReview');

+ 0 - 4
docs/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx

@@ -2,10 +2,6 @@
 title: "Navigation Types"
 generated: true
 ---
-
-
-## NavMenuBadge
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="19" packageName="@vendure/admin-ui" />
 
 A color-coded notification badge which will be displayed by the

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx

@@ -2,10 +2,6 @@
 title: "AssetPreviewPipe"
 generated: true
 ---
-
-
-## AssetPreviewPipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/asset-preview.pipe.ts" sourceLine="19" packageName="@vendure/admin-ui" />
 
 Given an Asset object (an object with `preview` and optionally `focalPoint` properties), this pipe

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/duration-pipe.mdx

@@ -2,10 +2,6 @@
 title: "DurationPipe"
 generated: true
 ---
-
-
-## DurationPipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/duration.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 
 Displays a number of milliseconds in a more human-readable format,

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx

@@ -2,10 +2,6 @@
 title: "FileSizePipe"
 generated: true
 ---
-
-
-## FileSizePipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/file-size.pipe.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 Formats a number into a human-readable file size string.

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx

@@ -2,10 +2,6 @@
 title: "HasPermissionPipe"
 generated: true
 ---
-
-
-## HasPermissionPipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/has-permission.pipe.ts" sourceLine="16" packageName="@vendure/admin-ui" />
 
 A pipe which checks the provided permission against all the permissions of the current user.

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx

@@ -2,10 +2,6 @@
 title: "LocaleCurrencyNamePipe"
 generated: true
 ---
-
-
-## LocaleCurrencyNamePipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-currency-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 
 Displays a human-readable name for a given ISO 4217 currency code.

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx

@@ -2,10 +2,6 @@
 title: "LocaleCurrencyPipe"
 generated: true
 ---
-
-
-## LocaleCurrencyPipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-currency.pipe.ts" sourceLine="20" packageName="@vendure/admin-ui" />
 
 Formats a Vendure monetary value (in cents) into the correct format for the configured currency and display

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx

@@ -2,10 +2,6 @@
 title: "LocaleDatePipe"
 generated: true
 ---
-
-
-## LocaleDatePipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-date.pipe.ts" sourceLine="19" packageName="@vendure/admin-ui" />
 
 A replacement of the Angular DatePipe which makes use of the Intl API

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx

@@ -2,10 +2,6 @@
 title: "LocaleLanguageNamePipe"
 generated: true
 ---
-
-
-## LocaleLanguageNamePipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-language-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 
 Displays a human-readable name for a given ISO 639-1 language code.

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx

@@ -2,10 +2,6 @@
 title: "LocaleRegionNamePipe"
 generated: true
 ---
-
-
-## LocaleRegionNamePipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-region-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 
 Displays a human-readable name for a given region.

+ 0 - 4
docs/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx

@@ -2,10 +2,6 @@
 title: "TimeAgoPipe"
 generated: true
 ---
-
-
-## TimeAgoPipe
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/time-ago.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 
 Converts a date into the format "3 minutes ago", "5 hours ago" etc.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-components/action-bar.mdx

@@ -2,10 +2,6 @@
 title: "ActionBar"
 generated: true
 ---
-
-
-## ActionBar
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/ActionBar.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 
 A container for the primary actions on a list or detail page

+ 0 - 4
docs/docs/reference/admin-ui-api/react-components/card.mdx

@@ -2,10 +2,6 @@
 title: "Card"
 generated: true
 ---
-
-
-## Card
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/Card.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 
 A card component which can be used to group related content.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-components/cds-icon.mdx

@@ -2,10 +2,6 @@
 title: "CdsIcon"
 generated: true
 ---
-
-
-## CdsIcon
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/CdsIcon.tsx" sourceLine="47" packageName="@vendure/admin-ui" />
 
 A React wrapper for the Clarity UI icon component.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-components/form-field.mdx

@@ -2,10 +2,6 @@
 title: "FormField"
 generated: true
 ---
-
-
-## FormField
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/FormField.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 
 A wrapper around form fields which provides a label, tooltip and error message.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-components/link.mdx

@@ -2,10 +2,6 @@
 title: "Link"
 generated: true
 ---
-
-
-## Link
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/Link.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 
 A React component which renders an anchor tag and navigates to the specified route when clicked.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-components/page-block.mdx

@@ -2,10 +2,6 @@
 title: "PageBlock"
 generated: true
 ---
-
-
-## PageBlock
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/PageBlock.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 
 A container for page content which provides a consistent width and spacing.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx

@@ -2,10 +2,6 @@
 title: "PageDetailLayout"
 generated: true
 ---
-
-
-## PageDetailLayout
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/PageDetailLayout.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 
 A responsive container for detail views with a main content area and an optional sidebar.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx

@@ -2,10 +2,6 @@
 title: "RichTextEditor"
 generated: true
 ---
-
-
-## RichTextEditor
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/RichTextEditor.tsx" sourceLine="60" packageName="@vendure/admin-ui" />
 
 A rich text editor component which uses ProseMirror (rich text editor) under the hood.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx

@@ -2,10 +2,6 @@
 title: "ReactCustomDetailComponentConfig"
 generated: true
 ---
-
-
-## ReactCustomDetailComponentConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-custom-detail-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
 
 Configures a React-based component to be placed in a detail page in the given location.

+ 1 - 5
docs/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx

@@ -2,13 +2,9 @@
 title: "ReactDataTableComponentConfig"
 generated: true
 ---
-
-
-## ReactDataTableComponentConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-data-table-component.ts" sourceLine="19" packageName="@vendure/admin-ui" />
 
-Configures a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a> to be placed in the given location.
+Configures a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink> to be placed in the given location.
 
 ```ts title="Signature"
 interface ReactDataTableComponentConfig {

+ 1 - 5
docs/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx

@@ -2,14 +2,10 @@
 title: "RegisterReactCustomDetailComponent"
 generated: true
 ---
-
-
-## registerReactCustomDetailComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-custom-detail-component.ts" sourceLine="40" packageName="@vendure/admin-ui" />
 
 Registers a React component to be rendered in a detail page in the given location.
-Components used as custom detail components can make use of the <a href='/reference/admin-ui-api/react-hooks/use-detail-component-data#usedetailcomponentdata'>useDetailComponentData</a> hook.
+Components used as custom detail components can make use of the <DocsLink href="/reference/admin-ui-api/react-hooks/use-detail-component-data#usedetailcomponentdata">useDetailComponentData</DocsLink> hook.
 
 ```ts title="Signature"
 function registerReactCustomDetailComponent(config: ReactCustomDetailComponentConfig): void

+ 0 - 4
docs/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx

@@ -2,10 +2,6 @@
 title: "RegisterReactDataTableComponent"
 generated: true
 ---
-
-
-## registerReactDataTableComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-data-table-component.ts" sourceLine="90" packageName="@vendure/admin-ui" />
 
 Registers a React component to be rendered in a data table in the given location.

+ 1 - 5
docs/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx

@@ -2,13 +2,9 @@
 title: "RegisterReactFormInputComponent"
 generated: true
 ---
-
-
-## registerReactFormInputComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-form-input-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
 
-Registers a React component to be used as a <a href='/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent'>FormInputComponent</a>.
+Registers a React component to be used as a <DocsLink href="/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent">FormInputComponent</DocsLink>.
 
 ```ts title="Signature"
 function registerReactFormInputComponent(id: string, component: ElementType): void

+ 0 - 4
docs/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx

@@ -2,10 +2,6 @@
 title: "RegisterReactRouteComponentOptions"
 generated: true
 ---
-
-
-## RegisterReactRouteComponentOptions
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-route-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
 
 Configuration for a React-based route component.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx

@@ -2,10 +2,6 @@
 title: "RegisterReactRouteComponent"
 generated: true
 ---
-
-
-## registerReactRouteComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-route-component.ts" sourceLine="30" packageName="@vendure/admin-ui" />
 
 Registers a React component to be used as a route component.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx

@@ -2,10 +2,6 @@
 title: "UseDetailComponentData"
 generated: true
 ---
-
-
-## useDetailComponentData
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-detail-component-data.ts" sourceLine="34" packageName="@vendure/admin-ui" />
 
 Provides the data available to React-based CustomDetailComponents.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx

@@ -2,10 +2,6 @@
 title: "UseFormControl"
 generated: true
 ---
-
-
-## useFormControl
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-form-control.ts" sourceLine="31" packageName="@vendure/admin-ui" />
 
 Provides access to the current FormControl value and a method to update the value.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-hooks/use-injector.mdx

@@ -2,10 +2,6 @@
 title: "UseInjector"
 generated: true
 ---
-
-
-## useInjector
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-injector.ts" sourceLine="27" packageName="@vendure/admin-ui" />
 
 Exposes the Angular injector which allows the injection of services into React components.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx

@@ -2,10 +2,6 @@
 title: "UseLazyQuery"
 generated: true
 ---
-
-
-## useLazyQuery
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-query.ts" sourceLine="119" packageName="@vendure/admin-ui" since="2.2.0" />
 
 A React hook which allows you to execute a GraphQL query lazily.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx

@@ -2,10 +2,6 @@
 title: "UseMutation"
 generated: true
 ---
-
-
-## useMutation
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-query.ts" sourceLine="181" packageName="@vendure/admin-ui" />
 
 A React hook which allows you to execute a GraphQL mutation.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx

@@ -2,10 +2,6 @@
 title: "UsePageMetadata"
 generated: true
 ---
-
-
-## usePageMetadata
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-page-metadata.ts" sourceLine="31" packageName="@vendure/admin-ui" />
 
 Provides functions for setting the current page title and breadcrumb.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-hooks/use-query.mdx

@@ -2,10 +2,6 @@
 title: "UseQuery"
 generated: true
 ---
-
-
-## useQuery
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-query.ts" sourceLine="43" packageName="@vendure/admin-ui" />
 
 A React hook which provides access to the results of a GraphQL query.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx

@@ -2,10 +2,6 @@
 title: "UseRichTextEditor"
 generated: true
 ---
-
-
-## useRichTextEditor
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-rich-text-editor.ts" sourceLine="40" packageName="@vendure/admin-ui" />
 
 Provides access to the ProseMirror (rich text editor) instance.

+ 0 - 4
docs/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx

@@ -2,10 +2,6 @@
 title: "UseRouteParams"
 generated: true
 ---
-
-
-## useRouteParams
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-route-params.ts" sourceLine="23" packageName="@vendure/admin-ui" />
 
 Provides access to the current route params and query params.

+ 0 - 4
docs/docs/reference/admin-ui-api/routes/register-route-component-options.mdx

@@ -2,10 +2,6 @@
 title: "RegisterRouteComponentOptions"
 generated: true
 ---
-
-
-## RegisterRouteComponentOptions
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-route-component.ts" sourceLine="19" packageName="@vendure/admin-ui" />
 
 Configuration for a route component.

+ 0 - 4
docs/docs/reference/admin-ui-api/routes/register-route-component.mdx

@@ -2,10 +2,6 @@
 title: "RegisterRouteComponent"
 generated: true
 ---
-
-
-## registerRouteComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-route-component.ts" sourceLine="79" packageName="@vendure/admin-ui" />
 
 Registers an Angular standalone component to be rendered in a route.

+ 1 - 9
docs/docs/reference/admin-ui-api/services/data-service.mdx

@@ -2,10 +2,6 @@
 title: "DataService"
 generated: true
 ---
-
-
-## DataService
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/data/providers/data.service.ts" sourceLine="34" packageName="@vendure/admin-ui" />
 
 Used to interact with the Admin API via GraphQL queries. Internally this service uses the
@@ -26,7 +22,7 @@ class DataService {
 
 <MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`}   />
 
-Perform a GraphQL query. Returns a <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a> which allows further control over
+Perform a GraphQL query. Returns a <DocsLink href="/reference/admin-ui-api/services/data-service#queryresult">QueryResult</DocsLink> which allows further control over
 they type of result returned, e.g. stream of values, single value etc.
 
 *Example*
@@ -65,10 +61,6 @@ const result$ = this.dataService.mutate(gql`
 
 
 </div>
-
-
-## QueryResult
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/data/query-result.ts" sourceLine="31" packageName="@vendure/admin-ui" />
 
 This class wraps the Apollo Angular QueryRef object and exposes some getters

+ 1 - 17
docs/docs/reference/admin-ui-api/services/modal-service.mdx

@@ -2,10 +2,6 @@
 title: "ModalService"
 generated: true
 ---
-
-
-## ModalService
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.service.ts" sourceLine="21" packageName="@vendure/admin-ui" />
 
 This service is responsible for instantiating a ModalDialog component and
@@ -30,7 +26,7 @@ class ModalService {
 
 <MemberInfo kind="method" type={`(component: Type<T> &#38; Type<<a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a><R>>, options?: <a href='/reference/admin-ui-api/services/modal-service#modaloptions'>ModalOptions</a><T>) => Observable<R | undefined>`}   />
 
-Create a modal from a component. The component must implement the <a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a> interface.
+Create a modal from a component. The component must implement the <DocsLink href="/reference/admin-ui-api/services/modal-service#dialog">Dialog</DocsLink> interface.
 Additionally, the component should include templates for the title and the buttons to be
 displayed in the modal dialog. See example:
 
@@ -78,10 +74,6 @@ Displays a modal dialog with the provided title, body and buttons.
 
 
 </div>
-
-
-## Dialog
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.types.ts" sourceLine="9" packageName="@vendure/admin-ui" />
 
 Any component intended to be used with the ModalService.fromComponent() method must implement
@@ -105,10 +97,6 @@ to this method and then complete.
 
 
 </div>
-
-
-## DialogConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.types.ts" sourceLine="33" packageName="@vendure/admin-ui" />
 
 Configures a generic modal dialog.
@@ -153,10 +141,6 @@ interface DialogConfig<T> {
 
 
 </div>
-
-
-## ModalOptions
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.types.ts" sourceLine="48" packageName="@vendure/admin-ui" />
 
 Options to configure the behaviour of the modal.

+ 0 - 12
docs/docs/reference/admin-ui-api/services/notification-service.mdx

@@ -2,10 +2,6 @@
 title: "NotificationService"
 generated: true
 ---
-
-
-## NotificationService
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/notification/notification.service.ts" sourceLine="54" packageName="@vendure/admin-ui" />
 
 Provides toast notification functionality.
@@ -70,10 +66,6 @@ Display a toast notification.
 
 
 </div>
-
-
-## NotificationType
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/notification/notification.service.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 The types of notification available.
@@ -81,10 +73,6 @@ The types of notification available.
 ```ts title="Signature"
 type NotificationType = 'info' | 'success' | 'error' | 'warning'
 ```
-
-
-## ToastConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/notification/notification.service.ts" sourceLine="23" packageName="@vendure/admin-ui" />
 
 Configuration for a toast notification.

+ 0 - 4
docs/docs/reference/admin-ui-api/tabs/page-tab-config.mdx

@@ -2,10 +2,6 @@
 title: "PageTabConfig"
 generated: true
 ---
-
-
-## PageTabConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/page/page.service.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 The object used to configure a new page tab.

+ 0 - 4
docs/docs/reference/admin-ui-api/tabs/register-page-tab.mdx

@@ -2,10 +2,6 @@
 title: "RegisterPageTab"
 generated: true
 ---
-
-
-## registerPageTab
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-page-tab.ts" sourceLine="24" packageName="@vendure/admin-ui" />
 
 Add a tab to an existing list or detail page.

+ 1 - 37
docs/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx

@@ -2,10 +2,6 @@
 title: "AdminUiExtension"
 generated: true
 ---
-
-
-## AdminUiExtension
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="130" packageName="@vendure/ui-devkit" />
 
 Defines extensions to the Admin UI application by specifying additional
@@ -166,14 +162,10 @@ exclude: ['**/*.spec.ts']
 
 
 </div>
-
-
-## TranslationExtension
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="18" packageName="@vendure/ui-devkit" />
 
 Defines extensions to the Admin UI translations. Can be used as a stand-alone extension definition which only adds translations
-without adding new UI functionality, or as part of a full <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextension'>AdminUiExtension</a>.
+without adding new UI functionality, or as part of a full <DocsLink href="/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextension">AdminUiExtension</DocsLink>.
 
 ```ts title="Signature"
 interface TranslationExtension {
@@ -203,10 +195,6 @@ translations: {
 
 
 </div>
-
-
-## StaticAssetExtension
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="44" packageName="@vendure/ui-devkit" />
 
 Defines extensions which copy static assets to the custom Admin UI application source asset directory.
@@ -228,10 +216,6 @@ directory.
 
 
 </div>
-
-
-## GlobalStylesExtension
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="60" packageName="@vendure/ui-devkit" />
 
 Defines extensions which add global styles to the custom Admin UI application.
@@ -253,10 +237,6 @@ incorporated into the Admin UI app global stylesheet.
 
 
 </div>
-
-
-## SassVariableOverridesExtension
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="76" packageName="@vendure/ui-devkit" />
 
 Defines an extension which allows overriding Clarity Design System's Sass variables used in styles on the Admin UI.
@@ -278,10 +258,6 @@ default values defined in Clarity.
 
 
 </div>
-
-
-## UiExtensionRouteDefinition
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="92" packageName="@vendure/ui-devkit" />
 
 Defines a route which will be added to the Admin UI application.
@@ -319,10 +295,6 @@ This is useful when the extension is intended to replace the default Admin UI, r
 
 
 </div>
-
-
-## StaticAssetDefinition
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="280" packageName="@vendure/ui-devkit" />
 
 A static asset can be provided as a path to the asset, or as an object containing a path and a new
@@ -331,10 +303,6 @@ name, which will cause the compiler to copy and then rename the asset.
 ```ts title="Signature"
 type StaticAssetDefinition = string | { path: string; rename: string }
 ```
-
-
-## AdminUiExtensionSharedModule
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="289" packageName="@vendure/ui-devkit" />
 
 Configuration defining a single NgModule with which to extend the Admin UI.
@@ -369,10 +337,6 @@ The name of the extension module class.
 
 
 </div>
-
-
-## AdminUiExtensionLazyModule
-
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="316" packageName="@vendure/ui-devkit" />
 
 Configuration defining a single NgModule with which to extend the Admin UI.

Some files were not shown because too many files changed in this diff