Browse Source

docs(core): Fix remaining markup issues

Michael Bromley 2 years ago
parent
commit
f4dadea020

+ 1 - 1
packages/core/src/bootstrap.ts

@@ -83,7 +83,7 @@ export async function bootstrap(userConfig: Partial<VendureConfig>): Promise<INe
  * NestJs [standalone application](https://docs.nestjs.com/standalone-applications) as well as convenience
  * methods for starting the job queue and health check server.
  *
- * Read more about the [Vendure Worker]({{< relref "vendure-worker" >}}).
+ * Read more about the [Vendure Worker](/guides/developer-guide/worker-job-queue/).
  *
  * @example
  * ```ts

+ 2 - 2
packages/core/src/config/entity-metadata/entity-metadata-modifier.ts

@@ -5,11 +5,11 @@ import { MetadataArgsStorage } from 'typeorm/metadata-args/MetadataArgsStorage';
  * A function which allows TypeORM entity metadata to be manipulated prior to the DB schema being generated
  * during bootstrap.
  *
- * {{% alert "warning" %}}
+ * :::caution
  * Certain DB schema modifications will result in auto-generated migrations which will lead to data loss. For instance,
  * changing the data type of a column will drop the column & data and then re-create it. To avoid loss of important data,
  * always check and modify your migration scripts as needed.
- * {{% /alert %}}
+ * :::
  *
  * @example
  * ```ts

+ 2 - 2
packages/core/src/config/vendure-config.ts

@@ -918,12 +918,12 @@ export interface EntityOptions {
      * entities via the API. The default uses a simple auto-increment integer
      * strategy.
      *
-     * {{% alert "warning" %}}
+     * :::caution
      * Note: changing from an integer-based strategy to a uuid-based strategy
      * on an existing Vendure database will lead to problems with broken foreign-key
      * references. To change primary key types like this, you'll need to start with
      * a fresh database.
-     * {{% /alert %}}
+     * :::
      *
      * @since 1.3.0
      * @default AutoIncrementIdStrategy

+ 2 - 2
packages/core/src/plugin/default-search-plugin/default-search-plugin.ts

@@ -43,10 +43,10 @@ export interface DefaultSearchReindexResponse extends SearchReindexResponse {
  * plugin, then make sure this one is used, otherwise you will not be able to search products via the
  * [`search` query](/reference/graphql-api/shop/queries#search).
  *
- * {{% alert "warning" %}}
+ * :::caution
  * Note that the quality of the fulltext search capabilities varies depending on the underlying database being used. For example,
  * the MySQL & Postgres implementations will typically yield better results than the SQLite implementation.
- * {{% /alert %}}
+ * :::
  *
  *
  * @example

+ 3 - 3
packages/core/src/service/services/history.service.ts

@@ -231,10 +231,10 @@ export interface UpdateCustomerHistoryEntryArgs<T extends keyof CustomerHistoryE
  *   }
  * }
  * ```
- * {{% alert %}}
+ * :::info
  * It is also possible to define a UI component to display custom history entry types. See the
- * [Custom History Timeline Components guide]({{< relref "custom-timeline-components" >}}).
- * {{% /alert %}}
+ * [Custom History Timeline Components guide](/guides/extending-the-admin-ui/custom-timeline-components/).
+ * :::
  *
  * @docsCategory services
  */

+ 2 - 2
packages/harden-plugin/src/harden.plugin.ts

@@ -83,9 +83,9 @@ import { HardenPluginOptions } from './types';
  * The complexity score is calculated by the [graphql-query-complexity library](https://www.npmjs.com/package/graphql-query-complexity),
  * and by default uses the {@link defaultVendureComplexityEstimator}, which is tuned specifically to the Vendure Shop API.
  *
- * {{% alert "warning" %}}
+ * :::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.
- * {{% /alert %}}
+ * :::
  *
  * The optimal max complexity score will vary depending on:
  *

+ 2 - 2
packages/payments-plugin/src/stripe/stripe.plugin.ts

@@ -137,10 +137,10 @@ import { StripePluginOptions } from './types';
  * 3. Once the form is submitted and Stripe processes the payment, the webhook takes care of updating the order without additional action
  * in the storefront. As in the code above, the customer will be redirected to `/checkout/confirmation/${orderCode}`.
  *
- * {{% alert "primary" %}}
+ * :::info
  * A full working storefront example of the Stripe integration can be found in the
  * [Remix Starter repo](https://github.com/vendure-ecommerce/storefront-remix-starter/tree/master/app/components/checkout/stripe)
- * {{% /alert %}}
+ * :::
  *
  * ## Local development
  *