veslx 0.1.50 → 0.1.52

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Eoin Murray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -23,7 +23,7 @@
 
 ## Why veslx?
 
-**veslx** is a zero-config CLI that transforms your markdown files into a polished documentation site. Write in MDX, import React components, render LaTeX equations, display image galleries, and create slide and pdf presentations—all from simple markdown files.
+**veslx** is a zero-config CLI that transforms your markdown files into a polished documentation site. Write in MDX, import React components, render LaTeX equations, display image galleries, and create slide presentations—all from simple markdown files.
 
 Built on Vite + React + Tailwind. Fast builds. Instant hot reload. Beautiful defaults.
 
@@ -41,13 +41,15 @@ That's it. Your docs are live at `localhost:3000` (or the next available port).
 ### Install
 
 ```bash
-# Using bun (recommended)
+# Using bun (fast)
 bun install -g veslx
 
-# Or npm
+# Or npm (Node 18+)
 npm install -g veslx
 ```
 
+Requires Node >= 18 or Bun >= 1.0.
+
 ### Create Your First Post
 
 ```bash
@@ -94,7 +96,6 @@ Open the URL printed in the console (defaults to [localhost:3000](http://localho
 | **Parameter Tables** | Display YAML/JSON configs with collapsible sections |
 | **Dark Mode** | Automatic theme switching |
 | **Hot Reload** | Instant updates during development |
-| **Print to PDF** | Export slides as landscape PDFs |
 
 ---
 
@@ -243,17 +244,6 @@ Final thoughts
 | `↑` `←` `k` | Previous slide |
 | Scroll | Natural trackpad scrolling |
 
-### Print to PDF
-
-1. Open slides in browser
-2. Press `Cmd+P` (or `Ctrl+P`)
-3. Select "Save as PDF"
-4. Choose **Landscape** orientation
-
-Each slide becomes one PDF page, centered and optimized for print.
-
----
-
 ## CLI Commands
 
 ```bash

package/bin/lib/build.ts

@@ -1,9 +1,10 @@
 import { build } from 'vite'
 import path from 'path'
 import fs from 'fs'
-import importConfig from "./import-config";
-import veslxPlugin from '../../plugin/src/plugin'
-import { log } from './log'
+import { fileURLToPath } from 'url'
+import importConfig from "./import-config.js";
+import veslxPlugin from '../../plugin/src/plugin.js'
+import { log } from './log.js'
 
 /**
  * Recursively copy a directory
@@ -24,16 +25,33 @@ function copyDirSync(src: string, dest: string) {
   }
 }
 
+function resolveVeslxRoot() {
+  const candidates = [
+    new URL('../..', import.meta.url),
+    new URL('../../..', import.meta.url),
+  ];
+
+  for (const candidate of candidates) {
+    const candidatePath = fileURLToPath(candidate);
+    if (fs.existsSync(path.join(candidatePath, 'vite.config.ts'))) {
+      return candidatePath;
+    }
+  }
+
+  return fileURLToPath(new URL('../..', import.meta.url));
+}
+
 interface PackageJson {
   name?: string;
   description?: string;
 }
 
 async function readPackageJson(cwd: string): Promise<PackageJson | null> {
-  const file = Bun.file(path.join(cwd, 'package.json'));
-  if (!await file.exists()) return null;
+  const packagePath = path.join(cwd, 'package.json');
+  if (!fs.existsSync(packagePath)) return null;
   try {
-    return await file.json();
+    const content = await fs.promises.readFile(packagePath, 'utf-8');
+    return JSON.parse(content) as PackageJson;
   } catch {
     return null;
   }
@@ -77,8 +95,8 @@ export default async function buildApp(dir?: string) {
     posts: fileConfig?.posts,
   };
 
-  const veslxRoot = new URL('../..', import.meta.url).pathname;
-  const configFile = new URL('../../vite.config.ts', import.meta.url).pathname;
+  const veslxRoot = resolveVeslxRoot();
+  const configFile = path.join(veslxRoot, 'vite.config.ts');
 
   // Build inside veslxRoot first (Vite requires outDir to be within or relative to root)
   const tempOutDir = path.join(veslxRoot, '.veslx-build')

package/bin/lib/import-config.ts

@@ -1,14 +1,15 @@
+import fs from 'fs';
+import path from 'path';
 import yaml from 'js-yaml';
-import type { VeslxConfig } from '../../plugin/src/types';
+import type { VeslxConfig } from '../../plugin/src/types.js';
 
 export default async function importConfig(root: string): Promise<VeslxConfig | undefined> {
-  const file = Bun.file(`${root}/veslx.yaml`);
+  const configPath = path.join(root, 'veslx.yaml');
 
-  if (!await file.exists()) {
+  if (!fs.existsSync(configPath)) {
     return undefined;
   }
 
-  const content = await file.text();
-  const config = yaml.load(content) as VeslxConfig;
-  return config;
+  const content = await fs.promises.readFile(configPath, 'utf-8');
+  return yaml.load(content) as VeslxConfig;
 }

package/bin/lib/init.ts

@@ -1,10 +1,11 @@
+import fs from "fs";
 import nodePath from "path";
 import yaml from "js-yaml";
 
 export default async function createNewConfig() {
   const configPath = "veslx.yaml";
 
-  if (await Bun.file(configPath).exists()) {
+  if (fs.existsSync(configPath)) {
     console.error(`Configuration file '${configPath}' already exists.`);
     return;
   }
@@ -22,7 +23,7 @@ export default async function createNewConfig() {
 
   const configStr = yaml.dump(config, { indent: 2, quotingType: '"' });
 
-  await Bun.write(configPath, configStr);
+  await fs.promises.writeFile(configPath, configStr, "utf-8");
 
   console.log(`Created veslx.yaml`);
   console.log(`\nEdit the file to customize your site, then run:`);

package/bin/lib/serve.ts

@@ -1,8 +1,10 @@
 import { createServer } from 'vite'
-import importConfig from "./import-config";
-import veslxPlugin from '../../plugin/src/plugin'
+import importConfig from "./import-config.js";
+import veslxPlugin from '../../plugin/src/plugin.js'
 import path from 'path'
-import { log } from './log'
+import fs from 'fs'
+import { fileURLToPath } from 'url'
+import { log } from './log.js'
 
 interface PackageJson {
   name?: string;
@@ -10,10 +12,11 @@ interface PackageJson {
 }
 
 async function readPackageJson(cwd: string): Promise<PackageJson | null> {
-  const file = Bun.file(path.join(cwd, 'package.json'));
-  if (!await file.exists()) return null;
+  const packagePath = path.join(cwd, 'package.json');
+  if (!fs.existsSync(packagePath)) return null;
   try {
-    return await file.json();
+    const content = await fs.promises.readFile(packagePath, 'utf-8');
+    return JSON.parse(content) as PackageJson;
   } catch {
     return null;
   }
@@ -64,6 +67,22 @@ async function listenWithFallback(server: Awaited<ReturnType<typeof createServer
   process.exit(1);
 }
 
+function resolveVeslxRoot() {
+  const candidates = [
+    new URL('../..', import.meta.url),
+    new URL('../../..', import.meta.url),
+  ];
+
+  for (const candidate of candidates) {
+    const candidatePath = fileURLToPath(candidate);
+    if (fs.existsSync(path.join(candidatePath, 'vite.config.ts'))) {
+      return candidatePath;
+    }
+  }
+
+  return fileURLToPath(new URL('../..', import.meta.url));
+}
+
 export default async function serve(dir?: string) {
   const cwd = process.cwd()
 
@@ -102,8 +121,8 @@ export default async function serve(dir?: string) {
     posts: fileConfig?.posts,
   };
 
-  const veslxRoot = new URL('../..', import.meta.url).pathname;
-  const configFile = new URL('../../vite.config.ts', import.meta.url).pathname;
+  const veslxRoot = resolveVeslxRoot();
+  const configFile = path.join(veslxRoot, 'vite.config.ts');
 
   // Final content directory: CLI arg already resolved, or resolve from config
   const finalContentDir = dir

package/bin/lib/start.ts

@@ -1,6 +1,11 @@
 import pm2 from "pm2";
 import path from "path";
-import { log } from './log'
+import { log } from './log.js'
+
+function toDaemonName(contentDir: string) {
+  const normalized = contentDir.replace(/[:\\/]+/g, '-').replace(/^-+/, '');
+  return `veslx-${normalized}`.toLowerCase();
+}
 
 export default async function start(dir?: string) {
   const cwd = process.cwd();
@@ -10,10 +15,16 @@ export default async function start(dir?: string) {
     ? (path.isAbsolute(dir) ? dir : path.resolve(cwd, dir))
     : cwd;
 
-  const name = `veslx-${contentDir.replace(/\//g, '-').replace(/^-/, '')}`.toLowerCase();
+  const name = toDaemonName(contentDir);
 
   // Build args for veslx serve
-  const args = dir ? ['veslx', 'serve', dir] : ['veslx', 'serve'];
+  const args = dir ? ['serve', dir] : ['serve'];
+  const cliPath = process.argv[1];
+  if (!cliPath) {
+    log.error('unable to resolve veslx binary path');
+    process.exit(1);
+    return;
+  }
 
   pm2.connect((err) => {
     if (err) {
@@ -24,7 +35,8 @@ export default async function start(dir?: string) {
 
     pm2.start({
       name: name,
-      script: 'bunx',
+      script: cliPath,
+      interpreter: process.execPath,
       args: args,
       cwd: cwd,
       autorestart: true,
@@ -43,4 +55,4 @@ export default async function start(dir?: string) {
       process.exit(0);
     });
   })
-}
+}

package/bin/lib/stop.ts

@@ -1,9 +1,18 @@
 import pm2 from "pm2";
-import { log } from './log'
+import path from "path";
+import { log } from './log.js'
 
-export default async function stop() {
+function toDaemonName(contentDir: string) {
+  const normalized = contentDir.replace(/[:\\/]+/g, '-').replace(/^-+/, '');
+  return `veslx-${normalized}`.toLowerCase();
+}
+
+export default async function stop(dir?: string) {
   const cwd = process.cwd();
-  const name = `veslx-${cwd.replace(/\//g, '-').replace(/^-/, '')}`.toLowerCase();
+  const contentDir = dir
+    ? (path.isAbsolute(dir) ? dir : path.resolve(cwd, dir))
+    : cwd;
+  const name = toDaemonName(contentDir);
 
   pm2.connect((err) => {
     if (err) {

package/bin/veslx.ts

@@ -1,13 +1,28 @@
-#!/usr/bin/env bun
+#!/usr/bin/env node
 
 import { cac } from "cac";
-import pkg from "../package.json";
-import init from "./lib/init";
-import serve from "./lib/serve";
-import start from "./lib/start";
-import stop from "./lib/stop";
-import build from "./lib/build";
-import { banner } from "./lib/log";
+import { createRequire } from "module";
+import init from "./lib/init.js";
+import serve from "./lib/serve.js";
+import start from "./lib/start.js";
+import stop from "./lib/stop.js";
+import build from "./lib/build.js";
+import { banner } from "./lib/log.js";
+
+const require = createRequire(import.meta.url);
+function tryRequire<T>(id: string): T | null {
+  try {
+    return require(id) as T;
+  } catch (err: any) {
+    if (err?.code === "MODULE_NOT_FOUND") return null;
+    throw err;
+  }
+}
+
+const pkg =
+  tryRequire<{ version?: string }>("../package.json") ??
+  tryRequire<{ version?: string }>("../../package.json") ??
+  {};
 
 const cli = cac("veslx");
 
@@ -26,7 +41,7 @@ cli
   .action(start);
 
 cli
-  .command("stop", "Stop the veslx deamon")
+  .command("stop [dir]", "Stop the veslx daemon")
   .action(stop);
 
 cli
@@ -34,7 +49,7 @@ cli
   .action(build)
 
 cli.help();
-cli.version(pkg.version);
+cli.version(pkg.version ?? "0.0.0");
 cli.parse();
 
 if (!cli.matchedCommand && process.argv.length <= 2) {

package/dist/bin/lib/build.js

@@ -0,0 +1,121 @@
+import { build } from 'vite';
+import path from 'path';
+import fs from 'fs';
+import { fileURLToPath } from 'url';
+import importConfig from "./import-config.js";
+import veslxPlugin from '../../plugin/src/plugin.js';
+import { log } from './log.js';
+/**
+ * Recursively copy a directory
+ */
+function copyDirSync(src, dest) {
+    fs.mkdirSync(dest, { recursive: true });
+    const entries = fs.readdirSync(src, { withFileTypes: true });
+    for (const entry of entries) {
+        const srcPath = path.join(src, entry.name);
+        const destPath = path.join(dest, entry.name);
+        if (entry.isDirectory()) {
+            copyDirSync(srcPath, destPath);
+        }
+        else {
+            fs.copyFileSync(srcPath, destPath);
+        }
+    }
+}
+function resolveVeslxRoot() {
+    const candidates = [
+        new URL('../..', import.meta.url),
+        new URL('../../..', import.meta.url),
+    ];
+    for (const candidate of candidates) {
+        const candidatePath = fileURLToPath(candidate);
+        if (fs.existsSync(path.join(candidatePath, 'vite.config.ts'))) {
+            return candidatePath;
+        }
+    }
+    return fileURLToPath(new URL('../..', import.meta.url));
+}
+async function readPackageJson(cwd) {
+    const packagePath = path.join(cwd, 'package.json');
+    if (!fs.existsSync(packagePath))
+        return null;
+    try {
+        const content = await fs.promises.readFile(packagePath, 'utf-8');
+        return JSON.parse(content);
+    }
+    catch {
+        return null;
+    }
+}
+async function getDefaultConfig(cwd) {
+    const pkg = await readPackageJson(cwd);
+    const folderName = path.basename(cwd);
+    const name = pkg?.name || folderName;
+    return {
+        dir: '.',
+        site: {
+            name,
+            description: pkg?.description || '',
+        }
+    };
+}
+export default async function buildApp(dir) {
+    const cwd = process.cwd();
+    // Resolve content directory from CLI arg
+    const contentDir = dir
+        ? (path.isAbsolute(dir) ? dir : path.resolve(cwd, dir))
+        : cwd;
+    // Get defaults first, then merge with config file if it exists
+    // Look for config in content directory first, then fall back to cwd
+    const defaults = await getDefaultConfig(contentDir);
+    const fileConfig = await importConfig(contentDir) || await importConfig(cwd);
+    // CLI argument takes precedence over config file
+    const config = {
+        dir: dir || fileConfig?.dir || defaults.dir,
+        site: {
+            ...defaults.site,
+            ...fileConfig?.site,
+        },
+        slides: fileConfig?.slides,
+        posts: fileConfig?.posts,
+    };
+    const veslxRoot = resolveVeslxRoot();
+    const configFile = path.join(veslxRoot, 'vite.config.ts');
+    // Build inside veslxRoot first (Vite requires outDir to be within or relative to root)
+    const tempOutDir = path.join(veslxRoot, '.veslx-build');
+    const finalOutDir = path.join(cwd, 'dist');
+    // Final content directory: CLI arg already resolved, or resolve from config
+    const finalContentDir = dir
+        ? contentDir
+        : (path.isAbsolute(config.dir) ? config.dir : path.resolve(cwd, config.dir));
+    await build({
+        root: veslxRoot,
+        configFile,
+        mode: 'production',
+        // Cache in user's project so it persists across bunx runs
+        cacheDir: path.join(cwd, 'node_modules/.vite'),
+        build: {
+            outDir: tempOutDir,
+            emptyOutDir: true,
+            watch: null, // Explicitly disable watch mode
+            rollupOptions: {
+                input: path.join(veslxRoot, 'index.html'),
+            },
+        },
+        plugins: [
+            veslxPlugin(finalContentDir, config)
+        ],
+        logLevel: 'info',
+    });
+    // Copy built files to user's dist directory
+    if (fs.existsSync(finalOutDir)) {
+        fs.rmSync(finalOutDir, { recursive: true });
+    }
+    copyDirSync(tempOutDir, finalOutDir);
+    // Copy index.html to 404.html for SPA fallback routing
+    // This works with GitHub Pages, Netlify, and many static servers
+    fs.copyFileSync(path.join(finalOutDir, 'index.html'), path.join(finalOutDir, '404.html'));
+    // Clean up temp build directory
+    fs.rmSync(tempOutDir, { recursive: true });
+    log.success(`dist/`);
+}

package/dist/bin/lib/import-config.js

@@ -0,0 +1,11 @@
+import fs from 'fs';
+import path from 'path';
+import yaml from 'js-yaml';
+export default async function importConfig(root) {
+    const configPath = path.join(root, 'veslx.yaml');
+    if (!fs.existsSync(configPath)) {
+        return undefined;
+    }
+    const content = await fs.promises.readFile(configPath, 'utf-8');
+    return yaml.load(content);
+}

package/dist/bin/lib/init.js

@@ -0,0 +1,24 @@
+import fs from "fs";
+import nodePath from "path";
+import yaml from "js-yaml";
+export default async function createNewConfig() {
+    const configPath = "veslx.yaml";
+    if (fs.existsSync(configPath)) {
+        console.error(`Configuration file '${configPath}' already exists.`);
+        return;
+    }
+    const cwd = process.cwd();
+    const folderName = nodePath.basename(cwd);
+    const config = {
+        dir: ".",
+        site: {
+            name: folderName,
+            github: "",
+        },
+    };
+    const configStr = yaml.dump(config, { indent: 2, quotingType: '"' });
+    await fs.promises.writeFile(configPath, configStr, "utf-8");
+    console.log(`Created veslx.yaml`);
+    console.log(`\nEdit the file to customize your site, then run:`);
+    console.log(`  veslx serve`);
+}

package/dist/bin/lib/log.js

@@ -0,0 +1,15 @@
+// Minimal CLI logger with subtle styling
+const dim = (s) => `\x1b[2m${s}\x1b[0m`;
+const cyan = (s) => `\x1b[36m${s}\x1b[0m`;
+const green = (s) => `\x1b[32m${s}\x1b[0m`;
+const red = (s) => `\x1b[31m${s}\x1b[0m`;
+export const log = {
+    info: (msg) => console.log(dim(`  ${msg}`)),
+    success: (msg) => console.log(`  ${green('✓')} ${msg}`),
+    error: (msg) => console.error(`  ${red('✗')} ${msg}`),
+    url: (url) => console.log(`  ${cyan(url)}`),
+    blank: () => console.log(),
+};
+export const banner = () => {
+    console.log(dim(`  veslx`));
+};

package/dist/bin/lib/serve.js

@@ -0,0 +1,132 @@
+import { createServer } from 'vite';
+import importConfig from "./import-config.js";
+import veslxPlugin from '../../plugin/src/plugin.js';
+import path from 'path';
+import fs from 'fs';
+import { fileURLToPath } from 'url';
+import { log } from './log.js';
+async function readPackageJson(cwd) {
+    const packagePath = path.join(cwd, 'package.json');
+    if (!fs.existsSync(packagePath))
+        return null;
+    try {
+        const content = await fs.promises.readFile(packagePath, 'utf-8');
+        return JSON.parse(content);
+    }
+    catch {
+        return null;
+    }
+}
+async function getDefaultConfig(cwd) {
+    const pkg = await readPackageJson(cwd);
+    const folderName = path.basename(cwd);
+    const name = pkg?.name || folderName;
+    return {
+        dir: '.',
+        site: {
+            name,
+            description: pkg?.description || '',
+        }
+    };
+}
+function isAddressInUse(err) {
+    if (!err || typeof err !== 'object')
+        return false;
+    const anyErr = err;
+    if (anyErr.code === 'EADDRINUSE')
+        return true;
+    return typeof anyErr.message === 'string' && anyErr.message.includes('already in use');
+}
+async function listenWithFallback(server) {
+    const startPort = server.config.server.port ?? 3000;
+    const maxAttempts = 50;
+    for (let attempt = 0; attempt < maxAttempts; attempt++) {
+        const port = startPort + attempt;
+        try {
+            await server.listen(port);
+            const address = server.httpServer?.address();
+            const resolvedPort = typeof address === 'object' && address ? address.port : port;
+            log.success(`listening :${resolvedPort}`);
+            return;
+        }
+        catch (err) {
+            if (!isAddressInUse(err)) {
+                throw err;
+            }
+            log.info(`busy :${port} → :${port + 1}`);
+        }
+    }
+    log.error(`no available ports from ${startPort} to ${startPort + maxAttempts - 1}`);
+    process.exit(1);
+}
+function resolveVeslxRoot() {
+    const candidates = [
+        new URL('../..', import.meta.url),
+        new URL('../../..', import.meta.url),
+    ];
+    for (const candidate of candidates) {
+        const candidatePath = fileURLToPath(candidate);
+        if (fs.existsSync(path.join(candidatePath, 'vite.config.ts'))) {
+            return candidatePath;
+        }
+    }
+    return fileURLToPath(new URL('../..', import.meta.url));
+}
+export default async function serve(dir) {
+    const cwd = process.cwd();
+    // Resolve content directory - CLI arg takes precedence
+    const contentDir = dir
+        ? (path.isAbsolute(dir) ? dir : path.resolve(cwd, dir))
+        : cwd;
+    // Get defaults first, then merge with config file if it exists
+    // Look for config in content directory first, then fall back to cwd
+    const defaults = await getDefaultConfig(contentDir);
+    // Track which config file was found for hot reload
+    let configPath;
+    const contentConfigPath = path.join(contentDir, 'veslx.yaml');
+    const cwdConfigPath = path.join(cwd, 'veslx.yaml');
+    let fileConfig = await importConfig(contentDir);
+    if (fileConfig) {
+        configPath = contentConfigPath;
+    }
+    else {
+        fileConfig = await importConfig(cwd);
+        if (fileConfig) {
+            configPath = cwdConfigPath;
+        }
+    }
+    // CLI argument takes precedence over config file
+    const config = {
+        dir: dir || fileConfig?.dir || defaults.dir,
+        site: {
+            ...defaults.site,
+            ...fileConfig?.site,
+        },
+        slides: fileConfig?.slides,
+        posts: fileConfig?.posts,
+    };
+    const veslxRoot = resolveVeslxRoot();
+    const configFile = path.join(veslxRoot, 'vite.config.ts');
+    // Final content directory: CLI arg already resolved, or resolve from config
+    const finalContentDir = dir
+        ? contentDir
+        : (path.isAbsolute(config.dir) ? config.dir : path.resolve(cwd, config.dir));
+    const server = await createServer({
+        root: veslxRoot,
+        configFile,
+        server: {
+            strictPort: true,
+        },
+        // Cache in user's project so it persists across bunx runs
+        cacheDir: path.join(cwd, 'node_modules/.vite'),
+        plugins: [
+            veslxPlugin(finalContentDir, config, { configPath })
+        ],
+    });
+    await listenWithFallback(server);
+    const info = server.resolvedUrls;
+    if (info?.local[0]) {
+        log.url(info.local[0]);
+    }
+    server.bindCLIShortcuts({ print: false });
+}