undocs 0.4.14 → 0.4.16

package/app/app.config.ts

@@ -1,7 +1,7 @@
 export default defineAppConfig({
   docs: {
-    socialBackground: 'https://github.com/unjs/undocs/blob/main/assets/ellipse.png?raw=true',
-    logo: '/icon.svg',
+    socialBackground: "https://github.com/unjs/undocs/blob/main/assets/ellipse.png?raw=true",
+    logo: "/icon.svg",
     github: undefined,
     socials: {},
     banner: {},
@@ -10,54 +10,54 @@ export default defineAppConfig({
   ui: {
     colors: {
       // primary: 'amber', // set in setup.mjs
-      important: 'violet',
-      neutral: 'neutral',
+      important: "violet",
+      neutral: "neutral",
     },
     prose: {
       codeIcon: {
-        '.config': 'vscode-icons:file-type-config',
+        ".config": "vscode-icons:file-type-config",
         // '.plugin': 'vscode-icons:file-type-plugin',
-        'package.json': 'vscode-icons:file-type-node',
-        'tsconfig.json': 'vscode-icons:file-type-tsconfig',
-        '.npmrc': 'vscode-icons:file-type-npm',
-        '.editorconfig': 'vscode-icons:file-type-editorconfig',
-        '.eslintrc': 'vscode-icons:file-type-eslint',
-        '.eslintrc.cjs': 'vscode-icons:file-type-eslint',
-        '.eslintignore': 'vscode-icons:file-type-eslint',
-        '.gitignore': 'vscode-icons:file-type-git',
-        'yarn.lock': 'vscode-icons:file-type-yarn',
-        '.env': 'vscode-icons:file-type-dotenv',
-        '.env.example': 'vscode-icons:file-type-dotenv',
-        '.vscode/settings.json': 'vscode-icons:file-type-vscode',
-        '.nuxtrc': 'vscode-icons:file-type-nuxt',
-        '.nuxtignore': 'vscode-icons:file-type-nuxt',
-        'nuxt.config.ts': 'vscode-icons:file-type-nuxt',
-        'nuxt.schema.ts': 'vscode-icons:file-type-nuxt',
-        'nitro.config.ts': 'i-undocs-nitro',
-        'vite.config.js': 'i-logos-vitejs',
-        'vite.config.mjs': 'i-logos-vitejs',
-        'vite.config.ts': 'i-logos-vitejs',
-        'tailwind.config.js': 'vscode-icons:file-type-tailwind',
-        'tailwind.config.ts': 'vscode-icons:file-type-tailwind',
-        ts: 'vscode-icons:file-type-typescript',
-        tsx: 'vscode-icons:file-type-typescript',
-        mjs: 'vscode-icons:file-type-js',
-        cjs: 'vscode-icons:file-type-js',
-        js: 'vscode-icons:file-type-js',
-        jsx: 'vscode-icons:file-type-js',
-        md: 'vscode-icons:file-type-markdown',
-        py: 'vscode-icons:file-type-python',
-        ico: 'vscode-icons:file-type-favicon',
-        npm: 'vscode-icons:file-type-npm',
-        pnpm: 'vscode-icons:file-type-pnpm',
-        npx: 'vscode-icons:file-type-npm',
-        yarn: 'vscode-icons:file-type-yarn',
-        bun: 'vscode-icons:file-type-bun',
-        node: 'vscode-icons:file-type-node',
-        deno: 'vscode-icons:file-type-deno',
-        yml: 'vscode-icons:file-type-yaml',
-        terminal: 'i-heroicons-command-line',
+        "package.json": "vscode-icons:file-type-node",
+        "tsconfig.json": "vscode-icons:file-type-tsconfig",
+        ".npmrc": "vscode-icons:file-type-npm",
+        ".editorconfig": "vscode-icons:file-type-editorconfig",
+        ".eslintrc": "vscode-icons:file-type-eslint",
+        ".eslintrc.cjs": "vscode-icons:file-type-eslint",
+        ".eslintignore": "vscode-icons:file-type-eslint",
+        ".gitignore": "vscode-icons:file-type-git",
+        "yarn.lock": "vscode-icons:file-type-yarn",
+        ".env": "vscode-icons:file-type-dotenv",
+        ".env.example": "vscode-icons:file-type-dotenv",
+        ".vscode/settings.json": "vscode-icons:file-type-vscode",
+        ".nuxtrc": "vscode-icons:file-type-nuxt",
+        ".nuxtignore": "vscode-icons:file-type-nuxt",
+        "nuxt.config.ts": "vscode-icons:file-type-nuxt",
+        "nuxt.schema.ts": "vscode-icons:file-type-nuxt",
+        "nitro.config.ts": "i-undocs-nitro",
+        "vite.config.js": "i-logos-vitejs",
+        "vite.config.mjs": "i-logos-vitejs",
+        "vite.config.ts": "i-logos-vitejs",
+        "tailwind.config.js": "vscode-icons:file-type-tailwind",
+        "tailwind.config.ts": "vscode-icons:file-type-tailwind",
+        ts: "vscode-icons:file-type-typescript",
+        tsx: "vscode-icons:file-type-typescript",
+        mjs: "vscode-icons:file-type-js",
+        cjs: "vscode-icons:file-type-js",
+        js: "vscode-icons:file-type-js",
+        jsx: "vscode-icons:file-type-js",
+        md: "vscode-icons:file-type-markdown",
+        py: "vscode-icons:file-type-python",
+        ico: "vscode-icons:file-type-favicon",
+        npm: "vscode-icons:file-type-npm",
+        pnpm: "vscode-icons:file-type-pnpm",
+        npx: "vscode-icons:file-type-npm",
+        yarn: "vscode-icons:file-type-yarn",
+        bun: "vscode-icons:file-type-bun",
+        node: "vscode-icons:file-type-node",
+        deno: "vscode-icons:file-type-deno",
+        yml: "vscode-icons:file-type-yaml",
+        terminal: "i-heroicons-command-line",
       },
     },
   },
-})
+});

package/app/app.vue

@@ -1,54 +1,56 @@
 <script setup lang="ts">
-import type { BannerProps } from '@nuxt/ui'
+import type { BannerProps } from "@nuxt/ui";
 
-const appConfig = useAppConfig()
+const appConfig = useAppConfig();
 
-const { data: navigation } = await useAsyncData('navigation', () => queryCollectionNavigation('content'))
-const { data: files } = useLazyAsyncData('search', () => queryCollectionSearchSections('content'), {
+const { data: navigation } = await useAsyncData("navigation", () =>
+  queryCollectionNavigation("content"),
+);
+const { data: files } = useLazyAsyncData("search", () => queryCollectionSearchSections("content"), {
   server: false,
-})
+});
 
-const twitterSite = appConfig.docs.socials?.twitter || appConfig.docs.socials?.x || undefined
-const browserTabIcon = appConfig.docs?.logo || undefined
+const twitterSite = appConfig.docs.socials?.twitter || appConfig.docs.socials?.x || undefined;
+const browserTabIcon = appConfig.docs?.logo || undefined;
 
 useSeoMeta({
   twitterSite: twitterSite ? `@${twitterSite}` : undefined,
-})
+});
 
 useHead({
   htmlAttrs: {
-    lang: appConfig.docs.lang || 'en',
+    lang: appConfig.docs.lang || "en",
   },
   link: [
     {
-      rel: 'icon',
+      rel: "icon",
       href: browserTabIcon,
     },
   ],
-})
+});
 
-const route = useRoute()
+const route = useRoute();
 
 onMounted(() => {
   watch(
     route,
     () => {
-      const hash = window.location.hash
+      const hash = window.location.hash;
       if (hash) {
-        let attempts = 0
+        let attempts = 0;
         const interval = setInterval(() => {
-          document.querySelector(hash)?.scrollIntoView()
+          document.querySelector(hash)?.scrollIntoView();
           if (attempts++ > 5) {
-            clearInterval(interval)
+            clearInterval(interval);
           }
-        }, 100)
+        }, 100);
       }
     },
     { immediate: true },
-  )
-})
+  );
+});
 
-provide('navigation', navigation)
+provide("navigation", navigation);
 </script>
 
 <template>

package/app/assets/main.css

@@ -1,5 +1,5 @@
 @theme static {
-  --font-sans: 'Inter', sans-serif;
+  --font-sans: "Inter", sans-serif;
 }
 
 :root {

package/app/components/AppFooter.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-const appConfig = useAppConfig()
+const appConfig = useAppConfig();
 </script>
 
 <template>

package/app/components/AppFooterNotes.vue

@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-const appConfig = useAppConfig()
+const appConfig = useAppConfig();
 </script>
 
 <template>
@@ -12,7 +12,7 @@ const appConfig = useAppConfig()
         >{{ appConfig.site.name }}
       </NuxtLink>
     </span>
-    &nbsp;<span class="text-muted">{{ appConfig.docs.shortDescription.replace(/\.$/, '') }}</span
+    &nbsp;<span class="text-muted">{{ appConfig.docs.shortDescription.replace(/\.$/, "") }}</span
     >.
   </p>
 </template>

package/app/components/AppFooterNotesBase.vue

@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-const appConfig = useAppConfig()
+const appConfig = useAppConfig();
 </script>
 
 <template>

package/app/components/AppHeader.vue

@@ -1,42 +1,40 @@
 <script setup lang="ts">
-const appConfig = useAppConfig()
-const docsNav = useDocsNav()
+const appConfig = useAppConfig();
+const docsNav = useDocsNav();
 
-const navigation = inject('navigation')
+const navigation = inject("navigation");
 
 const headerLinks = computed(() => {
-  return [
-    ...docsNav.links
-      .filter((link) => link.hasIndex)
-      .map((link) => {
-        return {
-          ...link,
-          children: undefined,
-          icon: '',
-          // children: link.children?.filter((child) => !child.children || child.children.some((c) => c.to === child.to)),
-        }
-      }),
-  ]
-})
+  return docsNav.links
+    .filter((link) => link.hasIndex)
+    .map((link) => {
+      return {
+        ...link,
+        children: undefined,
+        icon: "",
+        // children: link.children?.filter((child) => !child.children || child.children.some((c) => c.to === child.to)),
+      };
+    });
+});
 
 const mobileLinks = computed(() => {
   return navigation.value.map((item) => {
-    if (item.path === '/blog') {
+    if (item.path === "/blog") {
       return {
         ...item,
         children: undefined,
-      }
+      };
     }
     if (item.children?.length === 1) {
-      return item.children[0]
+      return item.children[0];
     }
-    const originalPath = item.path
+    const originalPath = item.path;
     if (item.children?.length && item.children.some((c) => c.path === originalPath)) {
-      item.title = titleCase(originalPath)
+      item.title = titleCase(originalPath);
     }
-    return item
-  })
-})
+    return item;
+  });
+});
 </script>
 
 <template>

package/app/components/AppHeaderVersionsMenu.vue

@@ -1,25 +1,25 @@
 <script setup lang="ts">
-const appConfig = useAppConfig()
+const appConfig = useAppConfig();
 
 const activeVersion = computed(() => {
-  return appConfig.docs.versions.find((version) => version.active) || appConfig.docs.versions[0]
-})
+  return appConfig.docs.versions.find((version) => version.active) || appConfig.docs.versions[0];
+});
 const items = computed(() => {
   return appConfig.docs.versions.map((version) => {
     if (activeVersion.value === version) {
       return {
         label: version.label,
-        type: 'checkbox' as const,
-        color: 'primary' as const,
+        type: "checkbox" as const,
+        color: "primary" as const,
         checked: true,
-      }
+      };
     }
     return {
       label: version.label,
       to: version.to,
-    }
-  })
-})
+    };
+  });
+});
 </script>
 
 <template>
@@ -40,7 +40,9 @@ const items = computed(() => {
       class="-mb-[6px] font-semibold rounded-full truncate"
       :class="[open && 'bg-primary/15']"
       :ui="{
-        trailingIcon: ['transition-transform duration-200', open ? 'rotate-180' : undefined].filter(Boolean).join(' '),
+        trailingIcon: ['transition-transform duration-200', open ? 'rotate-180' : undefined]
+          .filter(Boolean)
+          .join(' '),
       }"
     />
   </UDropdownMenu>

package/app/components/DocsCollapsable.vue

@@ -15,29 +15,29 @@
 </template>
 
 <script setup lang="ts">
-import { Disclosure, DisclosureButton, DisclosurePanel } from '@headlessui/vue'
+import { Disclosure, DisclosureButton, DisclosurePanel } from "@headlessui/vue";
 
-const appConfig = useAppConfig()
+const appConfig = useAppConfig();
 
 const config = computed(() => ({
   button: {
-    base: 'flex items-center gap-1 text-sm text-gray-500 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-200',
+    base: "flex items-center gap-1 text-sm text-gray-500 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-200",
     icon: {
       name: appConfig.ui.icons.chevron,
-      base: 'w-4 h-4 transform transition-transform duration-200',
-      active: '',
-      inactive: '-rotate-90',
+      base: "w-4 h-4 transform transition-transform duration-200",
+      active: "",
+      inactive: "-rotate-90",
     },
   },
-  panel: 'mt-4 ml-2 py-2.5 pl-4 border-l border-gray-200 dark:border-gray-800 [&>div]:!mt-0',
-}))
+  panel: "mt-4 ml-2 py-2.5 pl-4 border-l border-gray-200 dark:border-gray-800 [&>div]:!mt-0",
+}));
 
 defineProps({
   name: {
     type: String,
-    default: 'properties',
+    default: "properties",
   },
-})
+});
 
-const { ui } = useUI('prose.collapsible', undefined, config, undefined, true)
+const { ui } = useUI("prose.collapsible", undefined, config, undefined, true);
 </script>

package/app/components/IconMenuToggle.vue

@@ -1,11 +1,11 @@
 <script setup lang="ts">
 // Source: https://github.com/nuxt-content/docus/blob/main/layer/app/components/IconMenuToggle.vue
-import { motion } from 'motion-v'
-import type { VariantType } from 'motion-v'
+import { motion } from "motion-v";
+import type { VariantType } from "motion-v";
 
 const props = defineProps<{
-  open: boolean
-}>()
+  open: boolean;
+}>();
 
 const variants: { [k: string]: VariantType | ((custom: unknown) => VariantType) } = {
   normal: {
@@ -14,21 +14,21 @@ const variants: { [k: string]: VariantType | ((custom: unknown) => VariantType)
     opacity: 1,
   },
   close: (custom: unknown) => {
-    const c = custom as number
+    const c = custom as number;
     return {
       rotate: c === 1 ? 45 : c === 3 ? -45 : 0,
       y: c === 1 ? 6 : c === 3 ? -6 : 0,
       opacity: c === 2 ? 0 : 1,
       transition: {
-        type: 'spring',
+        type: "spring",
         stiffness: 260,
         damping: 20,
       },
-    }
+    };
   },
-}
+};
 
-const state = computed(() => (props.open ? 'close' : 'normal'))
+const state = computed(() => (props.open ? "close" : "normal"));
 </script>
 
 <template>

package/app/components/LandingBackground.vue

@@ -1,24 +1,28 @@
 <script setup lang="ts">
-const points = useState(() => new Array(16).fill(0).map(() => [Math.random(), Math.random()]))
+const points = useState(() =>
+  Array.from({ length: 16 })
+    .fill(0)
+    .map(() => [Math.random(), Math.random()]),
+);
 
-const poly = computed(() => points.value.map(([x, y]) => `${x * 100}% ${y * 100}%`).join(', '))
+const poly = computed(() => points.value.map(([x, y]) => `${x * 100}% ${y * 100}%`).join(", "));
 
 function jumpVal(val: number) {
-  return Math.random() > 0.5 ? val + (Math.random() - 0.5) / 2 : Math.random()
+  return Math.random() > 0.5 ? val + (Math.random() - 0.5) / 2 : Math.random();
 }
 
-let timeout
+let timeout;
 function jumpPoints() {
   for (let i = 0; i < points.value.length; i++) {
-    points.value[i] = [jumpVal(points.value[i][0]), jumpVal(points.value[i][1])]
+    points.value[i] = [jumpVal(points.value[i][0]), jumpVal(points.value[i][1])];
   }
-  timeout = setTimeout(jumpPoints, 2000 + Math.random() * 1000)
+  timeout = setTimeout(jumpPoints, 2000 + Math.random() * 1000);
 }
 
 onMounted(() => {
-  jumpPoints()
-  onUnmounted(() => clearTimeout(timeout))
-})
+  jumpPoints();
+  onUnmounted(() => clearTimeout(timeout));
+});
 </script>
 
 <template>

package/app/components/PageHeaderLinks.vue

@@ -1,44 +1,44 @@
 <script setup lang="ts">
-import { useClipboard } from '@vueuse/core'
-import { useRuntimeConfig } from '#imports'
+import { useClipboard } from "@vueuse/core";
+import { useRuntimeConfig } from "#imports";
 
-const route = useRoute()
-const appBaseURL = useRuntimeConfig().app?.baseURL || '/'
+const route = useRoute();
+const appBaseURL = useRuntimeConfig().app?.baseURL || "/";
 
-const { copy, copied } = useClipboard()
+const { copy, copied } = useClipboard();
 
-const markdownLink = computed(() => `${window?.location?.origin}${appBaseURL}raw${route.path}.md`)
+const markdownLink = computed(() => `${window?.location?.origin}${appBaseURL}raw${route.path}.md`);
 const items = [
   {
-    label: 'Copy Markdown Link',
-    icon: 'i-lucide-link',
+    label: "Copy Markdown Link",
+    icon: "i-lucide-link",
     onSelect() {
-      copy(markdownLink.value)
+      copy(markdownLink.value);
     },
   },
   {
-    label: 'View as Markdown',
-    icon: 'i-simple-icons:markdown',
-    target: '_blank',
+    label: "View as Markdown",
+    icon: "i-simple-icons:markdown",
+    target: "_blank",
     to: markdownLink.value,
   },
   {
-    label: 'Open in ChatGPT',
-    icon: 'i-simple-icons:openai',
-    target: '_blank',
+    label: "Open in ChatGPT",
+    icon: "i-simple-icons:openai",
+    target: "_blank",
     to: `https://chatgpt.com/?hints=search&q=${encodeURIComponent(`Read ${markdownLink.value} so I can ask questions about it.`)}`,
   },
   {
-    label: 'Open in Claude',
-    icon: 'i-simple-icons:anthropic',
-    target: '_blank',
+    label: "Open in Claude",
+    icon: "i-simple-icons:anthropic",
+    target: "_blank",
     to: `https://claude.ai/new?q=${encodeURIComponent(`Read ${markdownLink.value} so I can ask questions about it.`)}`,
   },
-]
+];
 
 async function copyPage() {
-  const page = await $fetch<string>(`/raw${route.path}.md`)
-  copy(page)
+  const page = await $fetch<string>(`/raw${route.path}.md`);
+  copy(page);
 }
 </script>
 
@@ -64,7 +64,12 @@ async function copyPage() {
         sideOffset: 8,
       }"
     >
-      <UButton icon="i-lucide-chevron-down" color="neutral" variant="soft" class="border-l border-muted" />
+      <UButton
+        icon="i-lucide-chevron-down"
+        color="neutral"
+        variant="soft"
+        class="border-l border-muted"
+      />
     </UDropdownMenu>
   </UFieldGroup>
 </template>

package/app/components/SocialButtons.vue

@@ -1,12 +1,12 @@
 <script setup lang="ts">
-const appConfig = useAppConfig()
+const appConfig = useAppConfig();
 
 const props = defineProps({
   githubOnly: {
     type: Boolean,
     default: false,
   },
-})
+});
 
 const socialLinks = computed(() => {
   return (
@@ -18,22 +18,22 @@ const socialLinks = computed(() => {
       .reverse() // x<>github
       // .filter(([key]) => props.socials?.includes(key) || !props.socials)
       .map(([key, value]) => {
-        if (typeof value === 'object') {
-          return value
+        if (typeof value === "object") {
+          return value;
         }
-        if (typeof value === 'string' && value) {
+        if (typeof value === "string" && value) {
           return {
             // Workaround: i-simple-icons-x i-simple-icons-github
             icon: `i-simple-icons-${key}`,
             label: titleCase(key),
             to: /^https?:\/\//.test(value) ? value : `https://${key}.com/${value}`,
-          }
+          };
         }
-        return undefined
+        return undefined;
       })
       .filter(Boolean)
-  )
-})
+  );
+});
 </script>
 <template>
   <UTooltip v-for="link of socialLinks" :key="link.label" :text="link.label">