slidev-workspace 0.6.0 → 0.6.2

package/dist/cli.js

@@ -15,7 +15,7 @@ import { spawn } from "child_process";
 //#region src/scripts/config.ts
 const DEFAULT_CONFIG = {
 	slidesDir: ["./slides"],
-	outputDir: "./dist",
+	outputDir: "./_gh-pages",
 	baseUrl: "/",
 	exclude: ["node_modules", ".git"],
 	hero: {
@@ -405,31 +405,26 @@ async function exportOgImages() {
 		process.exit(1);
 	}
 }
-async function copyToGhPages() {
+async function copySlidesToOutputDir() {
 	const workspaceCwd = process.env.SLIDEV_WORKSPACE_CWD || process.cwd();
 	const config = loadConfig(workspaceCwd);
 	const slidesDirs = resolveSlidesDirs(config, workspaceCwd);
-	const ghPagesDir = join(workspaceCwd, "_gh-pages");
-	console.log("📁 Copying files to _gh-pages directory...");
-	if (!existsSync(ghPagesDir)) mkdirSync(ghPagesDir, { recursive: true });
+	const deployDir = resolve(workspaceCwd, config.outputDir);
+	console.log(`📁 Copying slide builds into ${deployDir}...`);
+	if (!existsSync(deployDir)) mkdirSync(deployDir, { recursive: true });
 	for (const slidesDir of slidesDirs) {
 		if (!existsSync(slidesDir)) continue;
 		const slides = readdirSync(slidesDir, { withFileTypes: true }).filter((dirent) => dirent.isDirectory()).map((dirent) => dirent.name);
 		for (const slideName of slides) {
 			const slideDistDir = join(slidesDir, slideName, "dist");
-			const targetDir = join(ghPagesDir, slideName);
+			const targetDir = join(deployDir, slideName);
 			if (existsSync(slideDistDir)) {
-				console.log(`📋 Copying ${slideName} to _gh-pages...`);
+				console.log(`📋 Copying ${slideName}...`);
 				await cp(slideDistDir, targetDir, { recursive: true });
 			}
 		}
 	}
-	const previewDistDir = join(workspaceCwd, config.outputDir);
-	if (existsSync(previewDistDir)) {
-		console.log("📋 Copying preview app as index...");
-		await cp(previewDistDir, ghPagesDir, { recursive: true });
-	}
-	console.log("✅ All files copied to _gh-pages successfully!");
+	console.log(`✅ All slide assets copied into ${deployDir}!`);
 }
 async function runViteBuild() {
 	try {
@@ -437,7 +432,7 @@ async function runViteBuild() {
 		console.log("📦 Building Slidev Workspace for production...");
 		const config = createViteConfig();
 		await build(config);
-		await copyToGhPages();
+		await copySlidesToOutputDir();
 		console.log("✅ Build completed successfully!");
 	} catch (error) {
 		console.error("❌ Build failed:", error);

package/dist/index.d.ts

@@ -55,14 +55,24 @@ declare function useSlides(): {
 //#endregion
 //#region src/types/config.d.ts
 interface HeroConfig {
+  /** Main heading displayed at the top of the workspace page. */
   title: string;
+  /** Supporting copy shown under the hero title. */
   description: string;
 }
+/**
+ * Slidev Workspace configuration loaded from slidev-workspace.yaml.
+ */
 interface SlidevWorkspaceConfig {
+  /** One or more directories that contain slide packages. */
   slidesDir: string[];
+  /** Where the aggregated preview app should output its build. */
   outputDir: string;
+  /** Public base URL used when serving or building slides. */
   baseUrl: string;
+  /** Folder names to ignore when scanning for slides. */
   exclude: string[];
+  /** Hero content surfaced by the preview application. */
   hero: HeroConfig;
 }
 //#endregion

package/dist/index.js

@@ -64,7 +64,7 @@ function resolveImageUrl(slide, domain) {
 	if (hasOgImage) {
 		const imagePath = `og-image.png?v=${Date.now()}`;
 		try {
-			const path = IS_DEVELOPMENT ? pathJoin(slidePath, imagePath) : pathJoin(baseUrl, slidePath, imagePath);
+			const path = IS_DEVELOPMENT ? imagePath : pathJoin(baseUrl, slidePath, imagePath);
 			return new URL(path, domain).href;
 		} catch (error) {
 			console.error("Failed to resolve og-image.png path:", error);
@@ -83,7 +83,7 @@ function resolveImageUrl(slide, domain) {
 	if (background) {
 		if (isUrl(background)) return background;
 		try {
-			return IS_DEVELOPMENT ? new URL(pathJoin(slidePath, background), domain).href : new URL(pathJoin(baseUrl, slidePath, background), domain).href;
+			return IS_DEVELOPMENT ? new URL(background, domain).href : new URL(pathJoin(baseUrl, slidePath, background), domain).href;
 		} catch (error) {
 			console.error("Failed to resolve background path:", error);
 			return "https://cover.sli.dev";

package/dist/plugin-slides.js

@@ -6,7 +6,7 @@ import { spawn } from "child_process";
 //#region src/scripts/config.ts
 const DEFAULT_CONFIG = {
 	slidesDir: ["./slides"],
-	outputDir: "./dist",
+	outputDir: "./_gh-pages",
 	baseUrl: "/",
 	exclude: ["node_modules", ".git"],
 	hero: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slidev-workspace",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "A workspace tool for managing multiple Slidev presentations with API-based content management",
   "type": "module",
   "license": "MIT",

package/src/preview/composables/useSlides.test.ts

@@ -45,7 +45,7 @@ describe("resolveImageUrl (Development Mode)", () => {
 
     const result = resolveImageUrl(slide, domain);
 
-    expect(result).toBe("http://localhost:3001/og-image.png");
+    expect(result).toMatch(/^http:\/\/localhost:3001\/og-image\.png\?v=\d+$/);
   });
 
   it("should return seoMeta.ogImage when it's an absolute URL", async () => {
@@ -115,9 +115,7 @@ describe("resolveImageUrl (Development Mode)", () => {
 
     const result = resolveImageUrl(slide, domain);
 
-    expect(result).toBe(
-      "http://localhost:3001/slides-presentation-1/background.jpg",
-    );
+    expect(result).toBe("http://localhost:3001/background.jpg");
   });
 
   it("should return default cover when no image sources provided", async () => {
@@ -150,7 +148,7 @@ describe("resolveImageUrl (Development Mode)", () => {
 
     const result = resolveImageUrl(slide, domain);
 
-    expect(result).toBe("http://localhost:3001/og-image.png");
+    expect(result).toMatch(/^http:\/\/localhost:3001\/og-image\.png\?v=\d+$/);
     expect(result).not.toBe("https://example.com/image.jpg");
   });
 
@@ -217,13 +215,14 @@ describe("resolveImageUrl (Production Mode)", () => {
     const slide = createMockSlide({
       hasOgImage: true,
       baseUrl: "/slidev-workspace-starter",
+      path: "/slides-presentation-1/",
     });
     const domain = "https://my-slides.com";
 
     const result = resolveImageUrl(slide, domain);
 
-    expect(result).toBe(
-      "https://my-slides.com/slidev-workspace-starter/og-image.png",
+    expect(result).toMatch(
+      /^https:\/\/my-slides\.com\/slidev-workspace-starter\/slides-presentation-1\/og-image\.png\?v=\d+$/,
     );
   });
 
@@ -443,7 +442,9 @@ describe("useSlides (Development Mode)", () => {
 
       const firstSlide = slides.value[0];
 
-      expect(firstSlide.image).toBe("http://localhost:3001/og-image.png");
+      expect(firstSlide.image).toMatch(
+        /^http:\/\/localhost:3001\/og-image\.png\?v=\d+$/,
+      );
     });
 
     it("should use default cover when no background is provided", async () => {
@@ -540,8 +541,8 @@ describe("useSlides (Production Mode)", () => {
       const result = await setupUseSlidesProduction();
       const firstSlide = result.slides.value[0];
 
-      expect(firstSlide.image).toBe(
-        "https://my-slides.com/slidev-workspace-starter/og-image.png",
+      expect(firstSlide.image).toMatch(
+        /^https:\/\/my-slides\.com\/slidev-workspace-starter\/slides-presentation-1\/og-image\.png\?v=\d+$/,
       );
     });
 
@@ -567,8 +568,8 @@ describe("useSlides (Production Mode)", () => {
 
       // First slide has hasOgImage: true, so should use og-image.png
       expect(firstSlide.image).toContain("og-image.png");
-      expect(firstSlide.image).toBe(
-        "https://my-slides.com/slidev-workspace-starter/og-image.png",
+      expect(firstSlide.image).toMatch(
+        /^https:\/\/my-slides\.com\/slidev-workspace-starter\/slides-presentation-1\/og-image\.png\?v=\d+$/,
       );
     });
 

package/src/preview/composables/useSlides.ts

@@ -40,7 +40,7 @@ export function resolveImageUrl(slide: SlideInfo, domain: string): string {
     const imagePath = `og-image.png?v=${Date.now()}`;
     try {
       const path = IS_DEVELOPMENT
-        ? pathJoin(slidePath, imagePath)
+        ? imagePath
         : pathJoin(baseUrl, slidePath, imagePath);
 
       return new URL(path, domain).href;
@@ -74,7 +74,7 @@ export function resolveImageUrl(slide: SlideInfo, domain: string): string {
 
     try {
       return IS_DEVELOPMENT
-        ? new URL(pathJoin(slidePath, background), domain).href
+        ? new URL(background, domain).href
         : new URL(pathJoin(baseUrl, slidePath, background), domain).href;
     } catch (error) {
       console.error("Failed to resolve background path:", error);