Просмотр исходного кода

fix(docs): Update admonition syntax for remark-directive v4

Convert space-separated admonition labels to bracket syntax as required
by remark-directive v4 plugin (e.g., `:::warning Deprecated` becomes
`:::warning[Deprecated]`).
David Höck 22 часов назад
Родитель
Сommit
736febcad4

+ 1 - 1
docs/docs/guides/extending-the-admin-ui/getting-started/index.mdx

@@ -2,7 +2,7 @@
 title: 'Getting Started'
 ---
 
-:::warning Angular Admin UI Deprecation
+:::warning[Angular Admin UI Deprecation]
 The Angular-based Admin UI has been replaced by the new [React Admin Dashboard](/extending-the-dashboard/getting-started/). The Angular Admin UI will not be maintained after **July 2026**. 
 Until then, we will continue patching critical bugs and security issues. Community contributions will always be merged and released.
 

+ 2 - 2
docs/docs/guides/extending-the-dashboard/custom-form-components/index.mdx

@@ -254,7 +254,7 @@ operation argument.
 
 You can access validation data for the current field or the whole form by using the `useFormContext` hook.
 
-:::note Error Messages
+:::note[Error Messages]
 Your component does not need to handle standard error messages - the Dashboard will handle them for you.
 
 For example, if your custom field specifies a `pattern` property, the Dashboard will automatically display an error message
@@ -306,7 +306,7 @@ export const ValidatedInputComponent: DashboardFormComponent = ({ value, onChang
 }
 ```
 
-:::tip Best Practices
+:::tip[Best Practices]
 
 1. **Always use Shadcn UI components** from the `@vendure/dashboard` package for consistent styling
 2. **Handle React Hook Form events properly** - call `onChange` and `onBlur` appropriately for custom field components

+ 1 - 1
docs/docs/guides/extending-the-dashboard/customizing-pages/page-blocks.mdx

@@ -234,7 +234,7 @@ To find the `pageId` and `blockId` values for positioning your blocks:
 3. Hover over existing blocks to see their IDs
 4. Use these IDs in your block positioning configuration
 
-:::tip Best Practices
+:::tip[Best Practices]
 
 1. **Use descriptive IDs**: Choose clear, unique IDs for your blocks
 2. **Position thoughtfully**: Consider the user experience when placing blocks

+ 2 - 2
docs/docs/guides/extending-the-dashboard/deployment/index.mdx

@@ -51,7 +51,7 @@ export default defineConfig({
 
 ### 2. Add DashboardPlugin to Vendure Config
 
-:::info Angular Admin UI compatibility
+:::info[Angular Admin UI compatibility]
 If you want to use the Angular Admin UI and the Dashboard together, both plugins can now be used simultaneously without any special configuration.
 :::
 
@@ -151,7 +151,7 @@ export default defineConfig({
 });
 ```
 
-:::warning Build-Time Variables
+:::warning[Build-Time Variables]
 Environment variables are resolved at **build time** and embedded as static strings in the final bundles. Ensure these variables are available during the build process, not just at runtime.
 :::
 

+ 1 - 1
docs/docs/guides/extending-the-dashboard/getting-started/index.mdx

@@ -185,7 +185,7 @@ npx vite
 
 To stop the running dashboard, type `q` and hit enter.
 
-:::info Compatibility with the legacy Admin UI
+:::info[Compatibility with the legacy Admin UI]
 If you still need to run the legacy Angular-based Admin UI in parallel with the Dashboard,
 this is totally possible. Both plugins can now be used simultaneously without any special configuration.
 :::

+ 2 - 2
docs/docs/guides/extending-the-dashboard/navigation/index.mdx

@@ -158,7 +158,7 @@ Order values are scoped within each placement area. This means:
 
 This means if you want to add a section between Catalog and Sales in the top area, you might use `order: 250`. If you want to add a section before Settings in the bottom area, you could use `order: 150`.
 
-:::note Default Placement
+:::note[Default Placement]
 If you don't specify a `placement`, sections default to `'top'` placement.
 :::
 
@@ -311,7 +311,7 @@ Common icons for navigation sections:
 
 ## Best Practices
 
-:::tip Navigation Design Guidelines
+:::tip[Navigation Design Guidelines]
 
 1. **Use descriptive section names**: Choose clear, concise names that indicate the section's purpose
 2. **Group related functionality**: Keep logically related menu items in the same section

+ 7 - 7
docs/docs/guides/how-to/cms-integration-plugin/index.mdx

@@ -395,7 +395,7 @@ async findCollectionsForVariant(
 }
 ```
 
-:::info Additional Entity Types
+:::info[Additional Entity Types]
 The service can also includes `syncVariantToCms()` and `syncCollectionToCms()` methods that follow the same pattern as the product sync shown above.
 
 These implementations are omitted from this guide for brevity, but they handle their respective entity types with similar data fetching, relationship resolution, and error handling patterns.
@@ -410,7 +410,7 @@ This sync service provides the foundation for handling all Vendure-specific comp
 <Tabs>
 <TabItem value="storyblok" label="Storyblok">
 
-:::tip Working Example
+:::tip[Working Example]
 The complete, production-ready Storyblok implementation can be found in the [Storyblok integration example](https://github.com/vendurehq/examples/tree/master/examples/storyblok-cms-integration). Refer to it for a minimal working implementation.
 :::
 
@@ -728,7 +728,7 @@ The complete implementations can be found in the working [example repositories](
 </TabItem>
 <TabItem value="contentful" label="Contentful">
 
-:::tip Working Example
+:::tip[Working Example]
 The complete, production-ready Contentful implementation can be found in the [Contentful integration example](https://github.com/vendurehq/examples/tree/master/examples/contentful-cms-integration). It includes advanced features like locale mapping, bulk operations, and a robust setup process.
 :::
 
@@ -966,7 +966,7 @@ This same pattern is used to link variants to their parent product and to their
 
 These methods perform the core Create, Read, Update, and Delete logic. They rely on our centralized `makeContentfulRequest` method and handle the specifics of Contentful's API, such as versioning and the publish workflow.
 
-:::info Contentful's Publish Workflow
+:::info[Contentful's Publish Workflow]
 Contentful requires entries to be explicitly published before they are visible in the Delivery API. After creating or updating an entry, we must make a separate API call to publish it. Similarly, to delete an entry, it must first be unpublished.
 :::
 
@@ -1052,7 +1052,7 @@ This configuration provides a complete Contentful CMS integration that automatic
 
 <TabItem value="strapi" label="Strapi">
 
-:::tip Working Example
+:::tip[Working Example]
 The complete, production-ready Strapi implementation can be found in the [Strapi integration example](https://github.com/vendurehq/examples/tree/master/examples/strapi-cms-integration). It includes advanced features like plugin-based content types, batch operations, and relationship management.
 :::
 
@@ -1382,7 +1382,7 @@ The complete implementations can be found in the working [example repositories](
 </TabItem>
 <TabItem value="Sanity" label="Sanity">
 
-:::tip Working Example
+:::tip[Working Example]
 The complete, production-ready Sanity implementation can be found in the [Sanity integration example](https://github.com/vendurehq/examples/tree/master/examples/sanity-cms-integration). It includes advanced features like content type management and bulk operations.
 :::
 
@@ -1647,7 +1647,7 @@ https://github.com/vendurehq/examples/tree/master/examples/sanity-cms-integratio
 </TabItem>
 <TabItem value="payload" label="Payload">
 
-:::tip Working Example
+:::tip[Working Example]
 The complete, production-ready Payload implementation can be found in the [Payload integration example](https://github.com/vendurehq/examples/tree/master/examples/payload-cms-integration). It includes advanced features like local API communication, collection management, and relationship handling.
 :::
 

+ 1 - 1
docs/docs/guides/how-to/codegen/index.mdx

@@ -153,7 +153,7 @@ export class OrganizationService {
 
 ## Codegen for Admin UI extensions
 
-:::warning Deprecated
+:::warning[Deprecated]
 This section refers to the deprecated Angular-based Admin UI. The new React-based Dashboard has built-in graphql type safety
 and does not require additional setup.
 :::

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

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="147" packageName="@vendure/admin-ui-plugin" />
 
-:::warning Deprecated
+:::warning[Deprecated]
 From Vendure v3.5.0, the Angular-based Admin UI has been replaced by the new [React Admin Dashboard](/extending-the-dashboard/getting-started/).
 The Angular Admin UI will not be maintained after **July 2026**. Until then, we will continue patching critical bugs and security issues.
 Community contributions will always be merged and released.