sdocs 0.0.60 → 0.0.61

package/dist/server/app-gen.js

@@ -116,8 +116,11 @@ mount(Explorer, {
 		docs,
 		cssNames,
 		pageModules,
+		title: ${JSON.stringify(config.title)},
 		logo: ${JSON.stringify(config.logo)},
-		icon: ${JSON.stringify(config.icon)},
+		sections: ${JSON.stringify(config.sections)},
+		defaultSection: ${JSON.stringify(config.defaultSection)},
+		routing: ${JSON.stringify(config.routing ?? 'history')},
 		sidebarConfig: ${JSON.stringify(config.sidebar)},
 	}
 });`;
@@ -192,7 +195,7 @@ export async function generateDevFiles(config, cwd) {
     // Copy Explorer components into the staging dir so they're compiled outside node_modules
     await copyExplorerApp(sdocsDir);
     await linkStagedDeps(sdocsDir, cwd);
-    await writeFile(resolve(sdocsDir, 'index.html'), generateIndexHtml(config.logo));
+    await writeFile(resolve(sdocsDir, 'index.html'), generateIndexHtml(config.title));
     await writeFile(resolve(sdocsDir, 'entry.js'), generateEntryJs(config));
     return sdocsDir;
 }
@@ -205,7 +208,7 @@ export async function generateBuildFiles(config, cwd) {
     // Copy Explorer components into the staging dir
     await copyExplorerApp(sdocsDir);
     await linkStagedDeps(sdocsDir, cwd);
-    await writeFile(resolve(sdocsDir, 'index.html'), generateIndexHtml(config.logo));
+    await writeFile(resolve(sdocsDir, 'index.html'), generateIndexHtml(config.title));
     await writeFile(resolve(sdocsDir, 'entry.js'), generateEntryJs(config));
     const inputs = {
         main: resolve(sdocsDir, 'index.html'),

package/dist/server/config.js

@@ -8,8 +8,11 @@ const DEFAULTS = {
     open: false,
     css: null,
     static: null,
+    title: 'sdocs',
     logo: 'sdocs',
-    icon: 'sdocs',
+    sections: [],
+    defaultSection: 'Docs',
+    routing: null,
     sidebar: {
         order: {},
         open: [],
@@ -87,14 +90,26 @@ export function resolveConfig(userConfig) {
             ? userConfig.include
             : [userConfig.include]
         : DEFAULTS.include;
+    // Pre-0.0.61 configs: `logo` was the header text and `icon` the image.
+    // An `icon` key marks the old shape — map it onto the new keys and warn.
+    const legacy = userConfig;
+    const isLegacy = 'icon' in legacy;
+    if (isLegacy) {
+        console.warn("[sdocs] config `icon` was renamed: use `logo` for the image and `title` for the header text.");
+    }
+    const title = userConfig.title ?? (isLegacy && typeof legacy.logo === 'string' ? legacy.logo : undefined);
+    const logo = isLegacy ? legacy.icon : userConfig.logo;
     return {
         include,
         port: userConfig.port ?? DEFAULTS.port,
         open: userConfig.open ?? DEFAULTS.open,
         css: userConfig.css ?? DEFAULTS.css,
         static: userConfig.static ?? DEFAULTS.static,
-        logo: userConfig.logo ?? DEFAULTS.logo,
-        icon: userConfig.icon ?? DEFAULTS.icon,
+        title: title ?? DEFAULTS.title,
+        logo: logo ?? DEFAULTS.logo,
+        sections: userConfig.sections ?? DEFAULTS.sections,
+        defaultSection: userConfig.defaultSection ?? DEFAULTS.defaultSection,
+        routing: userConfig.routing ?? DEFAULTS.routing,
         sidebar: {
             order: userConfig.sidebar?.order ?? DEFAULTS.sidebar.order,
             open: userConfig.sidebar?.open ?? DEFAULTS.sidebar.open,

package/dist/types.d.ts

@@ -12,10 +12,21 @@ export interface SdocsConfig {
      * files for previews. Standalone CLI flows (`sdocs dev`/`build`); when
      * embedding the Vite plugin, use the host app's own public directory. */
     static?: string;
-    /** Sidebar logo text. Default: 'sdocs' */
-    logo?: string;
-    /** Sidebar logo icon: 'sdocs' for the built-in mascot, an image URL, or false to hide. Default: 'sdocs' */
-    icon?: string | false;
+    /** Header title text. Default: 'sdocs' */
+    title?: string;
+    /** Header logo: 'sdocs' for the built-in mascot, an image URL, or false to hide. Default: 'sdocs' */
+    logo?: string | false;
+    /** Top-bar section order. Sections come from `@Section/...` title prefixes;
+     * unlisted sections follow alphabetically. Default: default section first,
+     * rest alphabetical. */
+    sections?: string[];
+    /** Name of the section that docs without an `@Section/` prefix belong to.
+     * Default: 'Docs' */
+    defaultSection?: string;
+    /** URL style: 'history' for real paths (default in the standalone CLI,
+     * needs the server to fall back to the shell), 'hash' for #/ URLs
+     * (default when embedding — works under any host routing). */
+    routing?: 'history' | 'hash';
     /** Sidebar configuration */
     sidebar?: {
         /** Per-folder sort overrides. Keys are folder paths, 'root' for top level. '*' = unlisted items. */
@@ -74,8 +85,12 @@ export interface ResolvedSdocsConfig {
     open: boolean;
     css: string | Record<string, string> | null;
     static: string | null;
-    logo: string;
-    icon: string | false;
+    title: string;
+    logo: string | false;
+    sections: string[];
+    defaultSection: string;
+    /** null = per-mode default (standalone: history, embedded: hash) */
+    routing: 'history' | 'hash' | null;
     sidebar: {
         order: Record<string, string[]>;
         open: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sdocs",
-	"version": "0.0.60",
+	"version": "0.0.61",
 	"description": "A lightweight documentation tool for Svelte 5 components",
 	"type": "module",
 	"license": "MIT",