@sit-onyx/nuxt-docs 0.7.2 → 0.7.3

package/app/composables/useSidebarNavigation.ts

@@ -1,5 +1,5 @@
-import { computed, useAsyncData, useI18n, useLocalePath, useRoute } from "#imports"; // since nuxt 4.3 the auto-imports don't work for this composable anymore; Might be related to https://github.com/nuxt/nuxt/issues/22342
 import type { Collections, ContentNavigationItem } from "@nuxt/content";
+import { computed, useAsyncData, useI18n, useLocalePath, useRoute } from "#imports"; // since nuxt 4.3 the auto-imports don't work for this composable anymore; Might be related to https://github.com/nuxt/nuxt/issues/22342
 
 export type SidebarNavigationItem<TCollection extends keyof Collections = keyof Collections> = {
   title: string;
@@ -20,11 +20,11 @@ export type SidebarNavigationItem<TCollection extends keyof Collections = keyof
  * Custom navigation options. Can be set via the `.navigation.yml` file inside of a content folder.
  *
  * @example
- * ```yaml
- * # .navigation.yml
- * sidebar:
- *    root: true
- * ```
+ *   ```yaml
+ *   # .navigation.yml
+ *   sidebar:
+ *   root: true
+ *   ```;
  */
 export type SidebarNavigationOptions = {
   /**
@@ -104,8 +104,8 @@ export const useSidebarNavigation = async <
   });
 
   /**
-   * Finds the "previous root" (parent root) for the currently active route within the navigation tree.
-   * Useful to e.g. display a back button to traverse up the navigation tree.
+   * Finds the "previous root" (parent root) for the currently active route within the navigation
+   * tree. Useful to e.g. display a back button to traverse up the navigation tree.
    */
   const previousRootItem = computed(() => findPreviousRootItem(allItems.value, route.path));
 
@@ -117,7 +117,9 @@ export const useSidebarNavigation = async <
     items: SidebarNavigationItem<TCollection>[],
     currentPath: string,
   ): SidebarNavigationItem<TCollection> | undefined {
-    /** Helper function to check if a path exists anywhere in a node's subtree */
+    /**
+     * Helper function to check if a path exists anywhere in a node's subtree
+     */
     const containsPath = (node: SidebarNavigationItem, path: string): boolean => {
       if (node.path === path) return true;
       return node.children?.some((child) => containsPath(child, path)) ?? false;

package/app/error.vue

@@ -10,7 +10,7 @@ defineSlots<{
   /**
    * Slot to override the default "Back to home" action(s).
    *
-   * @params clearError - Function to clear the error and redirect to the home page
+   * @param clearError - Function to clear the error and redirect to the home page
    */
   actions?(props: { clearError: typeof _clearError }): unknown;
   /**

package/content.config.ts

@@ -1,5 +1,5 @@
-import { defineCollection, defineContentConfig } from "@nuxt/content";
 import path from "node:path";
+import { defineCollection, defineContentConfig } from "@nuxt/content";
 
 export default defineContentConfig({
   collections: {

package/modules/mdc.ts

@@ -0,0 +1,23 @@
+import * as onyxMdc from "@sit-onyx/mdc";
+import { addComponent, defineNuxtModule } from "nuxt/kit";
+
+export default defineNuxtModule({
+  meta: {
+    name: "@sit-onyx/mdc",
+  },
+  setup(options, nuxt) {
+    nuxt.options.css.push("@sit-onyx/mdc/style.css");
+
+    Object.keys(onyxMdc)
+      .filter((namedExport) => namedExport.startsWith("Prose"))
+      .forEach((component) => {
+        addComponent({
+          filePath: "@sit-onyx/mdc",
+          name: component,
+          export: component,
+          global: true, // required by Nuxt content
+          priority: 1, // prevent warning because we are overriding default Nuxt content components
+        });
+      });
+  },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sit-onyx/nuxt-docs",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "Nuxt layer/template for creating documentations with the onyx design system",
   "bugs": {
     "url": "https://github.com/SchwarzIT/onyx/issues"
@@ -15,7 +15,8 @@
   "files": [
     "app",
     "content.config.ts",
-    "nuxt.config.ts"
+    "nuxt.config.ts",
+    "modules"
   ],
   "type": "module",
   "main": "./nuxt.config.ts",
@@ -23,22 +24,22 @@
     "@sit-onyx/mdc": "^0.3.0"
   },
   "devDependencies": {
-    "@fontsource-variable/source-code-pro": "^5.2.7",
-    "@fontsource-variable/source-sans-3": "^5.2.9",
+    "@fontsource-variable/source-code-pro": "^5.3.0",
+    "@fontsource-variable/source-sans-3": "^5.3.0",
     "@nuxt/content": "^3.15.0",
     "@nuxt/test-utils": "^4.0.3",
     "@nuxtjs/color-mode": "^4.0.1",
-    "@nuxtjs/mdc": "~0.22.1",
+    "@nuxtjs/mdc": "~0.22.2",
     "@playwright/experimental-ct-vue": "1.61.1",
     "@playwright/test": "1.61.1",
-    "nuxt": "4.4.8",
+    "nuxt": "4.5.0",
     "sass-embedded": "1.100.0",
     "typescript": "6.0.3",
-    "vue": "3.5.39",
-    "@sit-onyx/icons": "^1.10.1",
-    "@sit-onyx/shared": "^0.1.0",
+    "vue": "3.5.40",
+    "@sit-onyx/icons": "^1.11.0",
     "@sit-onyx/nuxt": "^1.1.1",
-    "sit-onyx": "^1.17.0"
+    "@sit-onyx/shared": "^0.1.0",
+    "sit-onyx": "^1.18.0"
   },
   "peerDependencies": {
     "@fontsource-variable/source-code-pro": ">= 5",
@@ -48,9 +49,9 @@
     "@nuxtjs/i18n": ">= 10",
     "@nuxtjs/mdc": ">= 0.20.2",
     "sass-embedded": ">= 1",
-    "@sit-onyx/icons": "^1.10.1",
-    "sit-onyx": "^1.17.0",
-    "@sit-onyx/nuxt": "^1.1.1"
+    "@sit-onyx/icons": "^1.11.0",
+    "@sit-onyx/nuxt": "^1.1.1",
+    "sit-onyx": "^1.18.0"
   },
   "engines": {
     "node": ">=20"