@vendure/docs 0.0.0-202601161603 → 0.0.0-202601161707

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

@@ -15,12 +15,12 @@ This plugin enables payments to be processed by [Braintree](https://www.braintre
 
 1. You will need to create a Braintree sandbox account as outlined in https://developers.braintreepayments.com/start/overview.
 2. Then install `braintree` and `@types/braintree` from npm. This plugin was written with `v3.x` of the Braintree lib.
-    ```shell
+    ```bash
     yarn add @vendure/payments-plugin braintree
     yarn add -D @types/braintree
     ```
     or
-    ```shell
+    ```bash
     npm install @vendure/payments-plugin braintree
     npm install -D @types/braintree
     ```
@@ -53,7 +53,7 @@ The plugin is designed to work with the [Braintree drop-in UI](https://developer
 This is a library provided by Braintree which will handle the payment UI for you. You can install it in your storefront project
 with:
 
-```shell
+```bash
 yarn add braintree-web-drop-in
 # or
 npm install braintree-web-drop-in
@@ -208,7 +208,7 @@ BraintreePlugin.init({
 Since v1.8, it is possible to override vaulting on a per-payment basis by passing `includeCustomerId: false` to the `generateBraintreeClientToken`
 mutation:
 
-```GraphQL
+```graphql
 const { generateBraintreeClientToken } = await graphQlClient.query(gql`
   query GenerateBraintreeClientToken($includeCustomerId: Boolean) {
     generateBraintreeClientToken(includeCustomerId: $includeCustomerId)

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

@@ -46,7 +46,7 @@ In your storefront you add a payment to an order using the `createMolliePaymentI
 PaymentMethod was given the code "mollie-payment-method". The `redirectUrl``is the url that is used to redirect the end-user
 back to your storefront after completing the payment.
 
-```GraphQL
+```graphql
 mutation CreateMolliePaymentIntent {
   createMolliePaymentIntent(input: {
     redirectUrl: "https://storefront/order/1234XYZ" // Optional, the fallback redirect url set in the admin UI will be used if not provided
@@ -73,7 +73,7 @@ platform.
 'molliePaymentMethodCode' is an optional parameter that can be passed to skip Mollie's hosted payment method selection screen
 You can get available Mollie payment methods with the following query:
 
-```GraphQL
+```graphql
 {
  molliePaymentMethods(input: { paymentMethodCode: "mollie-payment-method" }) {
    id

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

@@ -52,7 +52,7 @@ The plugin is designed to work with the [Custom payment flow](https://stripe.com
 In this flow, Stripe provides libraries which handle the payment UI and confirmation for you. You can install it in your storefront project
 with:
 
-```shell
+```bash
 yarn add @stripe/stripe-js
 # or
 npm install @stripe/stripe-js
@@ -147,7 +147,7 @@ A full working storefront example of the Stripe integration can be found in the
 2. From your Stripe dashboard, go to Developers -> Webhooks and click "Add an endpoint" and follow the instructions
 under "Test in a local environment".
 3. The Stripe CLI command will look like
-   ```shell
+   ```bash
    stripe listen --forward-to localhost:3000/payments/stripe
    ```
 4. The Stripe CLI will create a webhook signing secret you can then use in your config of the StripePlugin.

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

@@ -32,7 +32,7 @@ which you will need to provide to the plugin.
 
 ## Installation
 
-```sh
+```bash
 npm install --save @vendure/sentry-plugin
 ```
 
@@ -58,13 +58,13 @@ Make sure the `SENTRY_DSN` environment variable is defined.
 The Sentry SDK must be initialized before your application starts. This is done by preloading
 the instrument file when starting your Vendure server:
 
-```sh
+```bash
 node --import @vendure/sentry-plugin/instrument ./dist/index.js
 ```
 
 Or if using TypeScript directly with tsx:
 
-```sh
+```bash
 tsx --import @vendure/sentry-plugin/instrument ./src/index.ts
 ```
 

package/docs/reference/graphql-api/_index.mdx

@@ -4,8 +4,6 @@ weight: 3
 showtoc: false
 ---
 
-# GraphQL API 
-
 This section contains a description of all queries, mutations and related types available in the Vendure GraphQL API.
 
 The API is split into two distinct endpoints: *Shop* and *Admin*. The Shop API is for storefront client applications, whereas the Admin API is used for administrative tasks.

package/docs/reference/graphql-api/admin/_index.mdx

@@ -4,8 +4,6 @@ weight: 4
 showtoc: false
 ---
 
-# GraphQL Admin API
-
 The Admin API is primarily used by the included Admin UI web app to perform administrative tasks such as inventory management, order tracking etc.
 
 :::note

package/docs/reference/graphql-api/shop/_index.mdx

@@ -4,8 +4,6 @@ weight: 3
 showtoc: false
 ---
 
-# GraphQL Shop API
-
 The Shop API is used by storefront applications. It provides all the necessary queries and mutations for finding and viewing products, creating and updating orders, checking out, managing a customer account etc.
 
 :::note

package/docs/reference/typescript-api/_index.mdx

@@ -4,8 +4,6 @@ weight: 9
 showtoc: false
 ---
 
-# Vendure TypeScript API Docs
-
 The Vendure TypeScript API is used when configuring the server (via the [`VendureConfig`](/reference/typescript-api/configuration/vendure-config/#vendureconfig) object) and when writing plugins that extend the functionality of Vendure core.
 
 :::note

package/docs/reference/typescript-api/auth/authentication-strategy.mdx

@@ -66,7 +66,7 @@ defineInputType() {
 assuming the strategy name is "my_auth", then the resulting call to `authenticate`
 would look like:
 
-```GraphQL
+```graphql
 authenticate(input: {
   my_auth: {
     token: "foo"

package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx

@@ -15,7 +15,7 @@ replacement for the <a href='/reference/typescript-api/cache/default-cache-plugi
 
 Note: To use this plugin, you need to manually install the `ioredis` package:
 
-```shell
+```bash
 npm install ioredis@^5.3.2
 ```
 

package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx

@@ -14,7 +14,7 @@ This is a high-performance cache strategy which is suitable for production use.
 
 Note: To use this strategy, you need to manually install the `ioredis` package:
 
-```shell
+```bash
 npm install ioredis@^5.3.2
 ```
 

package/docs/reference/typescript-api/data-access/list-query-builder.mdx

@@ -15,7 +15,7 @@ These queries all follow the same format:
 In the GraphQL definition, they return a type which implements the `Node` interface, and the query returns a
 type which implements the `PaginatedList` interface:
 
-```GraphQL
+```graphql
 type BlogPost implements Node {
   id: ID!
   published: DateTime!
@@ -184,7 +184,7 @@ not a column in the Order table, it exists on the Customer entity, and Order has
 
 *Example*
 
-```GraphQL
+```graphql
 """
 Manually extend the filter & sort inputs to include the new
 field that we want to be able to use in building list queries.
@@ -216,7 +216,7 @@ on the list query:
 
 *Example*
 
-```GraphQL
+```graphql
 query {
   myOrderQuery(options: {
     filter: {

package/docs/reference/typescript-api/orders/active-order-strategy.mdx

@@ -41,7 +41,7 @@ When `defineInputType()` is used, then the following Shop API operations will re
 
 *Example*
 
-```GraphQL {hl_lines=[5]}
+```graphql {hl_lines=[5]}
 mutation AddItemToOrder {
   addItemToOrder(
     productVariantId: 42,
@@ -168,7 +168,7 @@ defineInputType() {
 assuming the strategy name is "orderByToken", then the resulting call to `activeOrder` (or any of the other
 affected Shop API operations) would look like:
 
-```GraphQL
+```graphql
 activeOrder(activeOrderInput: {
   orderByToken: {
     token: "foo"

package/docs/reference/typescript-api/payment/dummy-payment-handler.mdx

@@ -16,7 +16,7 @@ By specifying certain metadata keys, failures can be simulated:
 
 *Example*
 
-```GraphQL
+```graphql
 addPaymentToOrder(input: {
   method: 'dummy-payment-method',
   metadata: {

package/docs/reference/typescript-api/request/relations-decorator.mdx

@@ -40,7 +40,7 @@ In the above example, given the following query:
 
 *Example*
 
-```GraphQL
+```graphql
 {
   orders(options: { take: 10 }) {
     items {
@@ -72,7 +72,7 @@ the above `orders` query were changed to:
 
 *Example*
 
-```GraphQL
+```graphql
 {
   orders(options: { take: 10 }) {
     items {

package/docs/user-guide/catalog/collections.mdx

@@ -3,8 +3,6 @@ title: "Collections"
 weight: 2
 ---
 
-# Collections
-
 Collections allow you to group ProductVariants together by various criteria. A typical use of Collections is to create a hierarchical category tree which can be used in a navigation menu in your storefront.
 
 ## Populating Collections

package/docs/user-guide/catalog/facets.mdx

@@ -3,8 +3,6 @@ title: "Facets"
 weight: 1
 ---
 
-# Facets
-
 Facets are the primary means to attach structured data to your Products & ProductVariants. Typical uses of Facets include:
 
 * Enabling faceted search & filtering in the storefront

package/docs/user-guide/catalog/products.mdx

@@ -2,8 +2,6 @@
 title: "Products"
 ---
 
-# Products
-
 Products represent the items you want to sell to your customers.
 
 ## Products vs ProductVariants

package/docs/user-guide/customers/index.mdx

@@ -3,8 +3,6 @@ title: "Customers"
 weight: 2
 ---
 
-# Customers
-
 A Customer is anybody who has:
 
 * Placed an order

package/docs/user-guide/index.mdx

@@ -1,7 +1,9 @@
-# Vendure User Guide
+---
+title: "Vendure User Guide"
+---
 
 This section is for store owners and staff who are charged with running a Vendure-based store.
 
 This guide assumes that your Vendure instance is running the AdminUiPlugin.
 
-We will roughly structure this guide to conform to the default layout of the Admin UI main navigation menu. 
+We will roughly structure this guide to conform to the default layout of the Admin UI main navigation menu.

package/docs/user-guide/localization/index.mdx

@@ -3,8 +3,6 @@ title: "Localization"
 weight: 10
 ---
 
-# Localization
-
 Vendure supports **customer-facing** (Shop API) localization by allowing you to define translations for the following objects:
 
 * Collections

package/docs/user-guide/orders/draft-orders.mdx

@@ -2,8 +2,6 @@
 title: "Draft Orders"
 ---
 
-# Draft Orders
-
 Draft Orders are used when an Administrator would like to manually create an order via the Admin UI. For example, this can be useful when:
 
 - A customer phones up to place an order

package/docs/user-guide/orders/orders.mdx

@@ -3,8 +3,6 @@ title: "Orders"
 weight: 3
 ---
 
-# Orders
-
 An Order is created whenever someone adds an item to their cart in the storefront. In Vendure, there is no distinction between a "cart" and an "order". Thus a "cart" is just an Order which has not yet passed through the checkout process.
 
 ## The Order Workflow

package/docs/user-guide/promotions/index.mdx

@@ -3,8 +3,6 @@ title: "Promotions"
 weight: 4
 ---
 
-# Promotions
-
 Promotions are a means of offering discounts on an order based on various criteria. A Promotion consists of _conditions_ and _actions_.
 
 * **conditions** are the rules which determine whether the Promotion should be applied to the order.

package/docs/user-guide/settings/administrators-roles.mdx

@@ -2,8 +2,6 @@
 title: "Administrators & Roles"
 ---
 
-# Administrators & Roles
-
 An **administrator** is a staff member who has access to the Admin UI, and is able to view and modify some or all of the items and settings.
 
 The exact permissions of _what_ a given administrator may view and modify is defined by which **roles** are assigned to that administrator.

package/docs/user-guide/settings/channels.mdx

@@ -2,8 +2,6 @@
 title: "Channels"
 ---
 
-# Channels
-
 Channels allow you to split your store into multiple sub-stores, each of which can have its own selection of inventory, customers, orders, shipping methods etc.
 
 There are various reasons why you might want to do this:

package/docs/user-guide/settings/countries-zones.mdx

@@ -2,8 +2,6 @@
 title: "Countries & Zones"
 ---
 
-# Countries & Zones
-
 **Countries** are where you define the list of countries which are relevant to your operations. This does not only include those countries you ship to, but also those countries which may appear on a billing address.
 
 By default, Vendure includes all countries in the list, but you are free to remove or disable any that you don't need.

package/docs/user-guide/settings/global-settings.mdx

@@ -2,8 +2,6 @@
 title: "Global Settings"
 ---
 
-# Global Settings
-
 The global settings allow you to define certain configurations that affect _all_ channels.
 
 * **Available languages** defines which languages you wish to make available for translations. When more than one language has been enabled, you will see the language switcher appear when viewing translatable objects such as products, collections, facets and shipping methods.

package/docs/user-guide/settings/payment-methods.mdx

@@ -2,8 +2,6 @@
 title: "Payment Methods"
 ---
 
-# Payment Methods
-
 Payment methods define how your storefront handles payments. Your storefront may offer multiple payment methods or just one.
 
 A Payment method consists of two parts: an **eligibility checker** and a **handler**

package/docs/user-guide/settings/shipping-methods.mdx

@@ -2,8 +2,6 @@
 title: "Shipping Methods"
 ---
 
-# Shipping Methods
-
 Shipping methods define:
 
 * Whether an order is eligible for a particular shipping method

package/docs/user-guide/settings/taxes.mdx

@@ -2,8 +2,6 @@
 title: "Taxes"
 ---
 
-# Taxes
-
 Taxes represent extra charges on top of the base price of a product. There are various forms of taxes that might be applicable, depending on local laws and the laws of the regions that your business serves. Common forms of applicable taxes are:
 
 * Value added tax (VAT)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vendure/docs",
-    "version": "0.0.0-202601161603",
+    "version": "0.0.0-202601161707",
     "type": "module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",