sdocs 0.0.31 → 0.0.33

package/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.33] - 2026-07-03
+
+### Added
+
+- **Embedded apps can deploy under a sub-path.** Preview URLs pick up the
+  host Vite `base` automatically; SvelteKit apps (whose base Vite doesn't
+  see) pass it explicitly via the new `previewBase` prop on `Explorer` —
+  e.g. `previewBase={base}` with `base` from `$app/paths`.
+
+## [0.0.32] - 2026-07-03
+
+### Changed
+
+- **Breaking: the embedded component is the Explorer now.** Import
+  `Explorer` from `sdocs/explorer` instead of `App` from `sdocs/client` —
+  same component and props, named for what it is. The CLI help and
+  generated app use the same naming.
+
 ## [0.0.31] - 2026-07-03
 
 ### Added

package/README.md

@@ -65,11 +65,11 @@ The plugin discovers `.sdoc` files and exposes them via a `virtual:sdocs` module
 ```svelte
 <!-- src/routes/docs/+page.svelte -->
 <script>
-  import App from 'sdocs/client';
+  import Explorer from 'sdocs/explorer';
   import { docs, cssNames } from 'virtual:sdocs';
 </script>
 
-<App
+<Explorer
   {docs}
   {cssNames}
   logo="My Design System"
@@ -273,7 +273,7 @@ sidebar: {
 |--------|-------------|
 | `sdocs` | Main entry — `sdocsPlugin` + types |
 | `sdocs/vite` | Vite plugin function |
-| `sdocs/client` | App.svelte UI component |
+| `sdocs/explorer` | Explorer.svelte UI component |
 | `sdocs/ui` | Reusable UI components (Button, Frame, Icon, Control, NavTree, Stack) |
 
 ## License

package/dist/commands/dev.js

@@ -44,7 +44,7 @@ export async function devCommand() {
             // Rolldown-based Vite (8+) can't scan .svelte entry graphs and floods
             // the console with unresolved-import errors. Skip the initial scan —
             // runtime discovery still optimizes dependencies on demand — and
-            // pre-bundle the one dependency the client app always needs.
+            // pre-bundle the one dependency the Explorer app always needs.
             entries: [],
             include: ['svelte'],
         },

package/dist/{client/App.svelte → explorer/Explorer.svelte}

@@ -7,7 +7,7 @@
 	import PageView from './views/PageView.svelte';
 	import LayoutView from './views/LayoutView.svelte';
 	import HomePage from './views/HomePage.svelte';
-	import { onMount } from 'svelte';
+	import { onMount, setContext } from 'svelte';
 	import '../ui/styles/sdocs.css';
 
 	type ThemeMode = 'light' | 'dark';
@@ -17,13 +17,24 @@
 		logo?: string;
 		icon?: string | false;
 		cssNames?: string[];
+		/** URL prefix for preview pages when the host app is served under a sub-path (e.g. SvelteKit's base). */
+		previewBase?: string;
 		sidebarConfig?: {
 			order?: Record<string, string[]>;
 			open?: string[];
 		};
 	}
 
-	let { docs, logo = 'sdocs', icon = 'sdocs', cssNames = [], sidebarConfig }: Props = $props();
+	let {
+		docs,
+		logo = 'sdocs',
+		icon = 'sdocs',
+		cssNames = [],
+		previewBase = '',
+		sidebarConfig
+	}: Props = $props();
+
+	setContext('sdocs-preview-base', previewBase);
 
 	let sidebarHidden = $state(false);
 	let activeStylesheet = $state<string | undefined>(undefined);

package/dist/explorer/Explorer.svelte.d.ts

@@ -0,0 +1,15 @@
+import { SvelteComponentTyped } from "svelte";
+import '../ui/styles/sdocs.css';
+declare const __propDef: {
+    props: Record<string, never>;
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export type ExplorerProps = typeof __propDef.props;
+export type ExplorerEvents = typeof __propDef.events;
+export type ExplorerSlots = typeof __propDef.slots;
+export default class Explorer extends SvelteComponentTyped<ExplorerProps, ExplorerEvents, ExplorerSlots> {
+}
+export {};

package/dist/{client → explorer}/views/PreviewFrame.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-	import { onMount, untrack } from 'svelte';
+	import { getContext, onMount, untrack } from 'svelte';
 
 	interface Props {
 		src: string;
@@ -10,6 +10,11 @@
 	}
 
 	let { src, props = {}, cssVars = {}, activeStylesheet, fullHeight = false }: Props = $props();
+
+	// Preview URLs are root-absolute; hosts serving under a sub-path pass the
+	// prefix via the Explorer's previewBase prop (see Explorer.svelte).
+	const previewBase = (getContext('sdocs-preview-base') as string | undefined) ?? '';
+	const resolvedSrc = $derived(previewBase.replace(/\/$/, '') + src);
 	let iframe: HTMLIFrameElement;
 	let ready = $state(false);
 	let contentHeight = $state(0);
@@ -73,7 +78,7 @@
 <div class="sdocs-preview-frame" class:full-height={fullHeight}>
 	<iframe
 		bind:this={iframe}
-		{src}
+		src={resolvedSrc}
 		title="Component preview"
 		class="sdocs-iframe"
 		scrolling="no"

package/dist/server/app-gen.js

@@ -7,13 +7,13 @@ import { discoverDocFiles, getSdocKind } from './discovery.js';
 import { extractSnippets, hasDefaultSnippet } from './snippet-extractor.js';
 import { base64urlEncode } from './snippet-compiler.js';
 const __dirname = dirname(fileURLToPath(import.meta.url));
-/** Source client directory in the installed package (dist/client, next to dist/server) */
-function getClientSourceDir() {
-    return resolve(__dirname, '../client');
+/** Source Explorer directory in the installed package (dist/explorer, next to dist/server) */
+function getExplorerSourceDir() {
+    return resolve(__dirname, '../explorer');
 }
-/** Copy the client app plus the ui/ tree it imports (styles, fonts, components) */
-async function copyClientApp(sdocsDir) {
-    await copyDir(getClientSourceDir(), resolve(sdocsDir, 'client'));
+/** Copy the Explorer app plus the ui/ tree it imports (styles, fonts, components) */
+async function copyExplorerApp(sdocsDir) {
+    await copyDir(getExplorerSourceDir(), resolve(sdocsDir, 'explorer'));
     await copyDir(resolve(__dirname, '../ui'), resolve(sdocsDir, 'ui'));
 }
 /** Nearest node_modules walking up from dir (mirrors Node's resolution) */
@@ -68,7 +68,7 @@ function generateIndexHtml(title) {
 <head>
 	<meta charset="UTF-8">
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
-	<link rel="icon" type="image/png" href="./client/favicon.png">
+	<link rel="icon" type="image/png" href="./explorer/favicon.png">
 	<title>${title}</title>
 	<style>body { margin: 0; }</style>
 </head>
@@ -78,13 +78,13 @@ function generateIndexHtml(title) {
 </body>
 </html>`;
 }
-/** Generate the entry.js that mounts the App */
+/** Generate the entry.js that mounts the Explorer */
 function generateEntryJs(config) {
     return `import { mount } from 'svelte';
 import { docs, cssNames } from 'virtual:sdocs';
-import App from './client/App.svelte';
+import Explorer from './explorer/Explorer.svelte';
 
-mount(App, {
+mount(Explorer, {
 	target: document.getElementById('app'),
 	props: {
 		docs,
@@ -122,8 +122,8 @@ function generatePreviewHtml(iframeVirtualId, css) {
 	<div id="app"></div>
 	<script type="module">
 		import { mount } from 'svelte';
-		import App from '${iframeVirtualId}';
-		mount(App, { target: document.getElementById('app') });
+		import Preview from '${iframeVirtualId}';
+		mount(Preview, { target: document.getElementById('app') });
 
 		window.addEventListener('message', (e) => {
 			if (e.data?.type === 'sdocs:update-stylesheet') {
@@ -165,8 +165,8 @@ async function discoverSnippets(config, cwd) {
 /** Generate the staging directory with entry files for dev mode */
 export async function generateDevFiles(config, cwd) {
     const sdocsDir = await createStagingDir(cwd);
-    // Copy client components into the staging dir so they're compiled outside node_modules
-    await copyClientApp(sdocsDir);
+    // Copy Explorer components into the staging dir so they're compiled outside node_modules
+    await copyExplorerApp(sdocsDir);
     await writeFile(resolve(sdocsDir, 'index.html'), generateIndexHtml(config.logo));
     await writeFile(resolve(sdocsDir, 'entry.js'), generateEntryJs(config));
     return sdocsDir;
@@ -174,8 +174,8 @@ export async function generateDevFiles(config, cwd) {
 /** Generate the staging directory with entry + preview HTML files for build mode */
 export async function generateBuildFiles(config, cwd) {
     const sdocsDir = await createStagingDir(cwd);
-    // Copy client components into the staging dir
-    await copyClientApp(sdocsDir);
+    // Copy Explorer components into the staging dir
+    await copyExplorerApp(sdocsDir);
     await writeFile(resolve(sdocsDir, 'index.html'), generateIndexHtml(config.logo));
     await writeFile(resolve(sdocsDir, 'entry.js'), generateEntryJs(config));
     const inputs = {

package/dist/server/cli.js

@@ -18,9 +18,9 @@ Usage:
   sdocs <command>
 
 Commands:
-  dev       Start development server with live reload
+  dev       Start the Explorer dev server with live reload
   run       Same as dev — works with npx and no local install
-  build     Build static documentation site
+  build     Build the Explorer as a static site
   preview   Serve built site locally
   init      Scaffold sdocs.config.js
 

package/dist/vite.js

@@ -21,6 +21,9 @@ export function sdocsPlugin(userConfig) {
     const buildMode = userConfig?._buildMode ?? false;
     let isBuild = false;
     let isSsrBuild = false;
+    // Host app's base path ('/' when served at the domain root); preview URLs
+    // are root-absolute and must carry it so embedding works under a sub-path.
+    let base = '/';
     // Previews planned for emission into a host app's build (embedded mode)
     let plannedPreviews = [];
     let emittedCssLinks = [];
@@ -30,6 +33,7 @@ export function sdocsPlugin(userConfig) {
             root = resolvedConfig.root;
             isBuild = resolvedConfig.command === 'build';
             isSsrBuild = !!resolvedConfig.build?.ssr;
+            base = resolvedConfig.base || '/';
             const fileConfig = await loadRawConfig(root);
             const merged = { ...fileConfig, ...userConfig };
             config = resolveAndFinalize(merged, root);
@@ -320,9 +324,13 @@ export function sdocsPlugin(userConfig) {
                 name: s.name,
                 body: s.body,
                 highlightedHtml: s.highlightedHtml,
-                previewUrl: buildMode || isBuild
-                    ? buildPreviewUrl(e.filePath, s.name)
-                    : previewUrl(e.filePath, s.name),
+                previewUrl: 
+                // Only absolute bases prefix here; SvelteKit builds with a relative
+                // base ('./') and passes its real path via the Explorer's previewBase.
+                (base.startsWith('/') && base !== '/' ? base.replace(/\/$/, '') : '') +
+                    (buildMode || isBuild
+                        ? buildPreviewUrl(e.filePath, s.name)
+                        : previewUrl(e.filePath, s.name)),
             })),
             highlightedSource: e.highlightedSource,
             toc: e.toc,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sdocs",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "description": "A lightweight documentation tool for Svelte 5 components",
   "type": "module",
   "license": "MIT",
@@ -21,8 +21,8 @@
       "types": "./dist/vite.d.ts",
       "default": "./dist/vite.js"
     },
-    "./client": {
-      "svelte": "./dist/client/App.svelte"
+    "./explorer": {
+      "svelte": "./dist/explorer/Explorer.svelte"
     },
     "./ui": {
       "types": "./dist/ui/index.d.ts",

package/dist/client/App.svelte.d.ts

@@ -1,15 +0,0 @@
-import { SvelteComponentTyped } from "svelte";
-import '../ui/styles/sdocs.css';
-declare const __propDef: {
-    props: Record<string, never>;
-    events: {
-        [evt: string]: CustomEvent<any>;
-    };
-    slots: {};
-};
-export type AppProps = typeof __propDef.props;
-export type AppEvents = typeof __propDef.events;
-export type AppSlots = typeof __propDef.slots;
-export default class App extends SvelteComponentTyped<AppProps, AppEvents, AppSlots> {
-}
-export {};