@bndynet/vue-site 0.1.0

package/README.md

@@ -0,0 +1,152 @@
+# @bndynet/vue-site
+
+Configurable Vue 3 site framework: one package, `site.config.ts`, and Markdown pages — sidebar, syntax-highlighted code, light/dark themes. No hand-written `main.ts`, `index.html`, or `vite.config.ts`.
+
+## Features
+
+- Config-driven nav (Lucide icon names)
+- Markdown (`?raw`) or Vue pages
+- highlight.js, light/dark theme + localStorage
+- Project `README.md` as Home
+- Full TypeScript types
+
+## Quick start
+
+**Install**
+
+```bash
+npm install @bndynet/vue-site
+```
+
+**`site.config.ts`**
+
+```typescript
+import { defineConfig } from '@bndynet/vue-site'
+
+export default defineConfig({
+  title: 'My Project',
+  nav: [
+    { label: 'Home', icon: 'home', page: () => import('./README.md?raw') },
+    { label: 'Guide', icon: 'book-open', page: () => import('./pages/guide.md?raw') },
+  ],
+})
+```
+
+**Layout**
+
+```
+my-site/
+  package.json
+  site.config.ts
+  README.md
+  pages/guide.md
+```
+
+**CLI** (`vue-site` and `vs` are the same)
+
+```bash
+npx vue-site dev
+npx vue-site build
+npx vue-site preview
+```
+
+Add `"dev": "vue-site dev"` (or `vs dev`) in `package.json` scripts if you like.
+
+## Config reference
+
+### `SiteConfig`
+
+| Property | Description |
+|----------|-------------|
+| `title` | Site title (sidebar + tab) |
+| `nav` | `NavItem[]` |
+| `logo` | Logo URL or imported image |
+| `theme` | See `ThemeConfig` below |
+| `footer` | Footer text |
+| `readme` | Raw Home content if no `README.md` |
+| `links` | Header links: Lucide `icon` + `link`, optional `title` |
+| `packageRepository` | Usually set by CLI from `package.json`; omit when using `createSiteApp` alone |
+| `env` | Dev/build options — see below |
+
+### `NavItem`
+
+| Property | Description |
+|----------|-------------|
+| `label` | Sidebar text |
+| `icon` | [Lucide](https://lucide.dev/icons) name |
+| `page` | `() => import('./page.md?raw')` or `() => import('./Page.vue')` |
+| `path` | Route path (derived from `label` if omitted) |
+| `children` | Nested group |
+
+### `ThemeConfig`
+
+| Property | Default | Description |
+|----------|---------|-------------|
+| `default` | `light` | `light`, `dark`, or an `extraThemes[].id` |
+| `colors` | — | Global CSS variable overrides |
+| `palettes` | — | Partial overrides for built-in light/dark only |
+| `extraThemes` | — | Extra themes: `id`, `label`, `icon`, optional `basedOn`, `palette`; import `builtinThemePalettes` for full defaults |
+
+## `env` (`SiteEnvConfig`)
+
+| Property | Description |
+|----------|-------------|
+| `port` | Dev server port |
+| `outDir` | Build output (relative to site root; default `{folder}-dist`) |
+| `customElements` | Tag prefixes for custom elements (e.g. `['chat-', 'i-']`) |
+| `watchPackages` | Local packages: package name string, or `{ name, entryPath }` for source HMR |
+| `vite` | Vite overrides (not `root`); framework merges aliases, `server.fs.allow`, `build.outDir`, etc. |
+
+## Library mode
+
+Own `index.html` + Vite setup:
+
+```typescript
+import { createSiteApp } from '@bndynet/vue-site'
+import '@bndynet/vue-site/style.css'
+import config from './site.config'
+
+createSiteApp(config).mount('#app')
+```
+
+Exports: `createSiteApp`, `defineConfig`, `useTheme`, `useSiteConfig`. Types: `SiteConfig`, `SiteEnvConfig`, `SiteViteConfig`, `SiteExternalLink`, `NavItem`, `ThemeConfig`, `ThemeOption`, `ThemePaletteVars`, `ResolvedNavItem`.
+
+### Theme in Vue pages (`useTheme`)
+
+Import `useTheme` from `@bndynet/vue-site`. It returns a reactive `theme` ref (the active theme id, e.g. `light`, `dark`, or an `extraThemes[].id`) plus `setTheme` and `toggleTheme`. The root layout also sets `document.documentElement` attribute `data-theme` and applies CSS variables, so you can style with `var(--color-*)` without JavaScript.
+
+```vue
+<script setup lang="ts">
+import { watch } from 'vue'
+import { useTheme } from '@bndynet/vue-site'
+
+const { theme, setTheme, toggleTheme } = useTheme()
+
+watch(theme, (next, prev) => {
+  if (prev !== undefined) console.log('theme:', prev, '→', next)
+})
+</script>
+
+<template>
+  <p>Current theme: {{ theme }}</p>
+</template>
+```
+
+## Upgrade
+
+```bash
+npm update @bndynet/vue-site
+```
+
+## Developing this repo
+
+```bash
+git clone https://github.com/bndynet/vue-site.git && cd vue-site
+npm install
+npm run dev    # watch-build lib + example site
+npm run build  # `dist/` + `example/example-dist`
+```
+
+## License
+
+MIT

package/bin/vue-site.mjs

@@ -0,0 +1,355 @@
+#!/usr/bin/env node
+
+import { createServer, build, preview, mergeConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import { resolve, dirname, basename } from 'path'
+import { fileURLToPath, pathToFileURL } from 'url'
+import { createRequire } from 'module'
+import { transform } from 'esbuild'
+import fs from 'fs'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+const pkgDir = resolve(__dirname, '..')
+const require = createRequire(import.meta.url)
+
+function resolvePkgDir(pkg) {
+  return dirname(require.resolve(`${pkg}/package.json`))
+}
+
+const vuePath = resolvePkgDir('vue')
+const vueRouterPath = resolvePkgDir('vue-router')
+const cwd = process.cwd()
+const command = process.argv[2] || 'dev'
+
+const configCandidates = [
+  'site.config.ts',
+  'site.config.js',
+  'site.config.mts',
+  'site.config.mjs',
+]
+const foundConfig = configCandidates.find((f) => fs.existsSync(resolve(cwd, f)))
+if (!foundConfig) {
+  console.error(
+    '\x1b[31mError: No site.config.ts found in the current directory.\x1b[0m\n\n' +
+    'Create a site.config.ts file:\n\n' +
+    '  import type { SiteConfig } from \'@bndynet/vue-site\'\n\n' +
+    '  export default {\n' +
+    '    title: \'My Site\',\n' +
+    '    nav: [\n' +
+    '      { label: \'Home\', icon: \'home\', page: () => import(\'./README.md?raw\') },\n' +
+    '    ],\n' +
+    '  } satisfies SiteConfig\n'
+  )
+  process.exit(1)
+}
+
+const VIRTUAL_ENTRY = 'virtual:vue-site-entry'
+const RESOLVED_ENTRY = '\0' + VIRTUAL_ENTRY
+const VIRTUAL_PACKAGE = 'virtual:vue-site-package'
+const RESOLVED_PACKAGE = '\0' + VIRTUAL_PACKAGE
+
+function parseRepositoryUrl(pkg) {
+  const r = pkg.repository
+  if (!r) return null
+  let url = typeof r === 'string' ? r : r.url
+  if (!url) return null
+  const ssh = /^git@([^:]+):(.+?)(\.git)?$/i.exec(url)
+  if (ssh) {
+    const host = ssh[1]
+    const path = ssh[2]
+    return `https://${host}/${path.replace(/\.git$/i, '')}`
+  }
+  url = url.replace(/^git\+/i, '')
+  url = url.replace(/\.git$/i, '')
+  if (/^github:/i.test(url)) {
+    return 'https://github.com/' + url.replace(/^github:/i, '')
+  }
+  if (/^gist:/i.test(url)) {
+    return 'https://gist.github.com/' + url.replace(/^gist:/i, '')
+  }
+  if (/^bitbucket:/i.test(url)) {
+    return 'https://bitbucket.org/' + url.replace(/^bitbucket:/i, '')
+  }
+  if (/^gitlab:/i.test(url)) {
+    return 'https://gitlab.com/' + url.replace(/^gitlab:/i, '')
+  }
+  if (url.startsWith('git:')) {
+    url = 'https:' + url.slice(4)
+  }
+  return url || null
+}
+
+function tryReadRepositoryFromDir(dir) {
+  try {
+    const pkgPath = resolve(dir, 'package.json')
+    if (!fs.existsSync(pkgPath)) return null
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
+    return parseRepositoryUrl(pkg)
+  } catch {
+    return null
+  }
+}
+
+/** Prefer parent directory's `repository`, then the site root (`cwd`) package.json. */
+function readPackageRepositoryUrl() {
+  const parentDir = resolve(cwd, '..')
+  const fromParent = tryReadRepositoryFromDir(parentDir)
+  if (fromParent) return fromParent
+  return tryReadRepositoryFromDir(cwd)
+}
+
+const entryCode = [
+  `import { createSiteApp } from '${pkgDir.replace(/\\/g, '/')}/dist/index.es.js'`,
+  `import '${pkgDir.replace(/\\/g, '/')}/dist/style.css'`,
+  `import siteConfig from '/${foundConfig}'`,
+  `import { repositoryUrl } from '${VIRTUAL_PACKAGE}'`,
+  `createSiteApp({ ...siteConfig, packageRepository: repositoryUrl }).mount('#app')`,
+].join('\n')
+
+const htmlTemplate = `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title></title>
+</head>
+<body>
+  <div id="app"></div>
+  <script type="module" src="/@id/__x00__${VIRTUAL_ENTRY}"></script>
+</body>
+</html>`
+
+async function loadSiteConfig() {
+  const configPath = resolve(cwd, foundConfig)
+  const raw = fs.readFileSync(configPath, 'utf-8')
+
+  const isTs = /\.m?ts$/.test(foundConfig)
+  const { code } = await transform(raw, {
+    loader: isTs ? 'ts' : 'js',
+    format: 'esm',
+  })
+
+  const stubbed = code.replace(
+    /import\s*\{[^}]*defineConfig[^}]*\}\s*from\s*['"][^'"]*['"]\s*;?/g,
+    'const defineConfig = (c) => c;',
+  )
+
+  const tmpFile = resolve(cwd, `.site-config.${Date.now()}.tmp.mjs`)
+  fs.writeFileSync(tmpFile, stubbed)
+
+  try {
+    const mod = await import(pathToFileURL(tmpFile).href)
+    return mod.default || {}
+  } catch (e) {
+    console.warn(
+      `[vue-site] Could not pre-load site config from ${foundConfig}: ${e.message}`,
+    )
+    return {}
+  } finally {
+    try {
+      fs.unlinkSync(tmpFile)
+    } catch {}
+  }
+}
+
+function vueSitePlugin() {
+  return [
+    {
+      name: 'vue-site:virtual-entry',
+      resolveId(id) {
+        if (id === VIRTUAL_ENTRY) return RESOLVED_ENTRY
+        if (id === VIRTUAL_PACKAGE) return RESOLVED_PACKAGE
+      },
+      load(id) {
+        if (id === RESOLVED_ENTRY) return entryCode
+        if (id === RESOLVED_PACKAGE) {
+          const url = readPackageRepositoryUrl()
+          return `export const repositoryUrl = ${JSON.stringify(url)}`
+        }
+      },
+    },
+    {
+      name: 'vue-site:html',
+      configureServer(server) {
+        return () => {
+          server.middlewares.use(async (req, res, next) => {
+            if (req.url === '/' || req.url === '/index.html') {
+              const html = await server.transformIndexHtml(
+                req.url,
+                htmlTemplate,
+              )
+              res.writeHead(200, { 'Content-Type': 'text/html' })
+              res.end(html)
+              return
+            }
+            next()
+          })
+        }
+      },
+    },
+  ]
+}
+
+async function buildViteConfig() {
+  const siteConfig = await loadSiteConfig()
+  const {
+    port,
+    outDir,
+    customElements = [],
+    watchPackages = [],
+    vite: userVite = {},
+  } = siteConfig.env || {}
+  const { vue: userVueOpts = {}, plugins: userPlugins, ...userViteRest } =
+    userVite
+
+  const vueOpts = { ...userVueOpts }
+  if (customElements.length) {
+    vueOpts.template = {
+      ...vueOpts.template,
+      compilerOptions: {
+        ...vueOpts.template?.compilerOptions,
+        isCustomElement: (tag) =>
+          customElements.some((prefix) => tag.startsWith(prefix)),
+      },
+    }
+  }
+
+  if (watchPackages.length) {
+    const excludeNames = []
+    const watchPatterns = []
+    const localAliases = {}
+    const fsAllowPaths = []
+
+    for (const pkg of watchPackages) {
+      if (typeof pkg === 'string') {
+        excludeNames.push(pkg)
+        watchPatterns.push(`!**/node_modules/${pkg}/**`)
+      } else {
+        const entryAbs = resolve(cwd, pkg.entryPath)
+        const entryDir = entryAbs.replace(/\/[^/]+$/, '')
+        excludeNames.push(pkg.name)
+        localAliases[pkg.name] = entryAbs
+        watchPatterns.push(`!${entryDir}/**`)
+        fsAllowPaths.push(entryDir)
+      }
+    }
+
+    userViteRest.optimizeDeps = {
+      ...userViteRest.optimizeDeps,
+      exclude: [
+        ...(userViteRest.optimizeDeps?.exclude || []),
+        ...excludeNames,
+      ],
+    }
+    userViteRest.server = {
+      ...userViteRest.server,
+      watch: {
+        ...userViteRest.server?.watch,
+        ignored: [
+          ...(userViteRest.server?.watch?.ignored || []),
+          ...watchPatterns,
+        ],
+      },
+    }
+    if (Object.keys(localAliases).length) {
+      userViteRest.resolve = {
+        ...userViteRest.resolve,
+        alias: { ...userViteRest.resolve?.alias, ...localAliases },
+      }
+    }
+    if (fsAllowPaths.length) {
+      userViteRest.server = {
+        ...userViteRest.server,
+        fs: {
+          ...userViteRest.server?.fs,
+          allow: [
+            ...(userViteRest.server?.fs?.allow || []),
+            ...fsAllowPaths,
+          ],
+        },
+      }
+    }
+  }
+
+  const baseConfig = {
+    root: cwd,
+    plugins: [vue(vueOpts), ...vueSitePlugin(), ...(userPlugins || [])],
+    resolve: {
+      alias: {
+        vue: resolve(vuePath, 'dist/vue.runtime.esm-bundler.js'),
+        'vue-router': resolve(vueRouterPath, 'dist/vue-router.mjs'),
+      },
+    },
+    server: {
+      open: true,
+      ...(port != null && { port }),
+      fs: {
+        allow: [cwd, pkgDir],
+      },
+    },
+    build: {
+      outDir: resolve(cwd, outDir || `${basename(cwd)}-dist`),
+      emptyOutDir: true,
+    },
+  }
+
+  return mergeConfig(userViteRest, baseConfig)
+}
+
+async function run() {
+  const viteConfig = await buildViteConfig()
+
+  if (command === 'dev') {
+    const server = await createServer(viteConfig)
+    await server.listen()
+    server.printUrls()
+    server.bindCLIShortcuts({ print: true })
+  } else if (command === 'build') {
+    const tempHtml = resolve(cwd, 'index.html')
+    const hadHtml = fs.existsSync(tempHtml)
+
+    if (!hadHtml) {
+      const buildHtml = `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title></title>
+</head>
+<body>
+  <div id="app"></div>
+  <script type="module">
+import { createSiteApp } from '${pkgDir.replace(/\\/g, '/')}/dist/index.es.js'
+import '${pkgDir.replace(/\\/g, '/')}/dist/style.css'
+import siteConfig from './${foundConfig}'
+import { repositoryUrl } from '${VIRTUAL_PACKAGE}'
+createSiteApp({ ...siteConfig, packageRepository: repositoryUrl }).mount('#app')
+  </script>
+</body>
+</html>`
+      fs.writeFileSync(tempHtml, buildHtml)
+    }
+
+    try {
+      await build(viteConfig)
+    } finally {
+      if (!hadHtml) {
+        fs.unlinkSync(tempHtml)
+      }
+    }
+  } else if (command === 'preview') {
+    const server = await preview(
+      mergeConfig(viteConfig, { preview: { open: true } }),
+    )
+    server.printUrls()
+  } else {
+    console.log('Usage: vue-site|vs <dev|build|preview>')
+    process.exit(1)
+  }
+}
+
+run().catch((err) => {
+  console.error(err)
+  process.exit(1)
+})

package/dist/components/AppLayout.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+export default _default;

package/dist/components/DynamicIcon.vue.d.ts

@@ -0,0 +1,6 @@
+type __VLS_Props = {
+    name: string;
+    size?: number;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/MarkdownView.vue.d.ts

@@ -0,0 +1,5 @@
+type __VLS_Props = {
+    content: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/components/NavGroup.vue.d.ts

@@ -0,0 +1,6 @@
+import { ResolvedNavItem } from '../types';
+type __VLS_Props = {
+    item: ResolvedNavItem;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/components/NavItem.vue.d.ts

@@ -0,0 +1,9 @@
+import { ResolvedNavItem } from '../types';
+type __VLS_Props = {
+    item: ResolvedNavItem;
+    indent?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    indent: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/PageView.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+export default _default;

package/dist/components/SideNav.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLElement>;
+export default _default;

package/dist/components/SiteExternalLinks.vue.d.ts

@@ -0,0 +1,8 @@
+type __VLS_Props = {
+    /** Smaller hit targets for sidebar footer */
+    compact?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    compact: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/ThemeSwitch.vue.d.ts

@@ -0,0 +1,10 @@
+type __VLS_Props = {
+    compact?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    compact: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    detailsRef: HTMLDetailsElement;
+    summaryRef: HTMLElement;
+}, HTMLDetailsElement>;
+export default _default;

package/dist/components/TooltipOverlay.vue.d.ts

@@ -0,0 +1,18 @@
+type __VLS_Props = {
+    /** Matches `aria-describedby` on the trigger */
+    id: string;
+    open: boolean;
+    text: string;
+    /** Trigger element (pass a template ref; it unwraps to the DOM node) */
+    anchor: HTMLElement | null;
+    placement?: 'top' | 'bottom';
+};
+declare function measure(): void;
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    measure: typeof measure;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    placement: "top" | "bottom";
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    tipRef: HTMLDivElement;
+}, any>;
+export default _default;

package/dist/components/TopPrimaryNav.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLElement>;
+export default _default;

package/dist/components/UiTooltip.vue.d.ts

@@ -0,0 +1,35 @@
+type __VLS_Props = {
+    /** Tooltip text (empty hides tooltip behavior) */
+    label: string;
+    placement?: 'top' | 'bottom';
+    /** Hover delay before showing (ms) */
+    showDelay?: number;
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {
+            describedBy: string | undefined;
+        }): any;
+    };
+    refs: {
+        root: HTMLSpanElement;
+    };
+    rootEl: HTMLSpanElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
+    open: import('vue').Ref<boolean, boolean>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    placement: "top" | "bottom";
+    showDelay: number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    root: HTMLSpanElement;
+}, HTMLSpanElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/composables/useNavLayout.d.ts

@@ -0,0 +1,5 @@
+export declare function useNavLayout(): {
+    tieredNav: import('vue').ComputedRef<boolean>;
+    sidebarNav: import('vue').ComputedRef<import('..').ResolvedNavItem[]>;
+    showSidebar: import('vue').ComputedRef<boolean>;
+};

package/dist/composables/useSiteConfig.d.ts

@@ -0,0 +1,9 @@
+import { InjectionKey } from 'vue';
+import { SiteConfig, ResolvedNavItem } from '../types';
+export interface SiteContext {
+    config: SiteConfig;
+    resolvedNav: ResolvedNavItem[];
+}
+export declare const siteContextKey: InjectionKey<SiteContext>;
+export declare function provideSiteConfig(context: SiteContext): void;
+export declare function useSiteConfig(): SiteContext;

package/dist/composables/useTheme.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @param defaultMode — used when nothing valid is in localStorage
+ * @param themeIds — full list of allowed ids (built-in `light`/`dark` plus any `extraThemes`)
+ * @param palettes — resolved CSS variable maps per id
+ * @param overlay — optional `:root` overrides applied after the active palette
+ */
+export declare function initTheme(defaultMode?: string, themeIds?: readonly string[], palettes?: Record<string, Record<string, string>>, overlay?: Record<string, string>): void;
+export declare function useTheme(): {
+    theme: import('vue').Ref<string, string>;
+    setTheme: (mode: string) => void;
+    toggleTheme: () => void;
+};

package/dist/create-app.d.ts

@@ -0,0 +1,2 @@
+import { SiteConfig } from './types';
+export declare function createSiteApp(config: SiteConfig): import('vue').App<Element>;

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { SiteConfig } from './types';
+export { createSiteApp } from './create-app';
+export { useTheme } from './composables/useTheme';
+export { useSiteConfig } from './composables/useSiteConfig';
+export { builtinThemePalettes } from './theme/presets';
+export type { SiteConfig, SiteEnvConfig, SiteViteConfig, SiteExternalLink, NavItem, ThemeConfig, ThemeOption, ThemePaletteVars, ResolvedNavItem, } from './types';
+export declare function defineConfig(config: SiteConfig): SiteConfig;