veslx 0.0.21 → 0.0.22

package/README.md

@@ -1,3 +1,130 @@
-
 # veslx
 
+A CLI tool for turning markdown directories into beautiful documentation sites and slide presentations.
+
+## Installation
+
+```bash
+bun install -g veslx
+```
+
+## Quick Start
+
+```bash
+# Initialize in your content directory
+veslx init
+
+# Start development server
+veslx serve
+
+# Build for production
+veslx build
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `veslx init` | Create a `veslx.config.ts` configuration file |
+| `veslx serve` | Start development server with hot reload |
+| `veslx build` | Build for production to `dist/` |
+| `veslx start` | Run as a background daemon (PM2) |
+| `veslx stop` | Stop the daemon |
+
+## Content Structure
+
+veslx scans your content directory for markdown files and renders them as posts or slides:
+
+```
+content/
+├── my-post/
+│   ├── README.mdx      # Rendered as a blog post
+│   └── SLIDES.mdx      # Rendered as a presentation
+├── another-post/
+│   └── README.mdx
+└── ...
+```
+
+### Frontmatter
+
+Add YAML frontmatter to control metadata:
+
+```mdx
+---
+title: My Post Title
+date: 2025-01-15
+description: A brief description of the post
+visibility: public
+---
+
+Your content here...
+```
+
+| Field | Description |
+|-------|-------------|
+| `title` | Display title (falls back to directory name) |
+| `date` | Publication date |
+| `description` | Short description shown in listings |
+| `visibility` | Set to `hidden` to hide from listings |
+
+### Slides
+
+Create presentations in `SLIDES.mdx` files. Separate slides with `---`:
+
+```mdx
+---
+title: My Presentation
+---
+
+# Slide 1
+
+Content for the first slide
+
+---
+
+# Slide 2
+
+Content for the second slide
+```
+
+Navigate slides with arrow keys or `j`/`k`.
+
+## Configuration
+
+The `veslx.config.ts` file specifies your content directory:
+
+```typescript
+export default {
+  dir: './content',
+}
+```
+
+## Features
+
+- **MDX Support** - Write with React components in markdown
+- **Math Rendering** - LaTeX equations via KaTeX
+- **Syntax Highlighting** - Code blocks with Shiki
+- **Hot Reload** - See changes instantly during development
+- **Slide Presentations** - Keyboard-navigable slides from markdown
+- **Dark Mode** - Automatic theme switching
+- **Daemon Mode** - Run as a background service with PM2
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Run locally
+bun run dev
+
+# Type check
+bun run typecheck
+
+# Lint
+bun run lint
+```
+
+## License
+
+MIT

package/bin/lib/build.ts

@@ -19,6 +19,11 @@ export default async function buildApp() {
   const veslxRoot = new URL('../..', import.meta.url).pathname;
   const outDir = path.join(cwd, 'dist')
 
+  // Resolve content directory relative to user's cwd (where config lives)
+  const contentDir = path.isAbsolute(config.dir)
+    ? config.dir
+    : path.resolve(cwd, config.dir);
+
   await build({
     root: veslxRoot,
     configFile: new URL('../../vite.config.ts', import.meta.url).pathname,
@@ -27,7 +32,7 @@ export default async function buildApp() {
       emptyOutDir: true,
     },
     plugins: [
-      veslxPlugin(config.dir)
+      veslxPlugin(contentDir)
     ],
   })
 

package/bin/lib/serve.ts

@@ -3,26 +3,6 @@ import { createServer, preview } from 'vite'
 import importConfig from "./import-config";
 import veslxPlugin from '../../plugin/src/plugin'
 import path from 'path'
-import fs from 'fs'
-
-// Find the node_modules directory that contains actual dependencies
-// This handles both local dev (node_modules in project root) and
-// bunx execution (node_modules in temp dir parent)
-function findNodeModulesDir(startDir: string): string {
-  let dir = startDir
-  while (dir !== '/' && dir !== '.') {
-    const nm = path.join(dir, 'node_modules')
-    // Check if node_modules exists and has real packages (not just .vite cache)
-    if (fs.existsSync(nm)) {
-      const contents = fs.readdirSync(nm)
-      if (contents.some(f => !f.startsWith('.') && f !== 'veslx')) {
-        return nm
-      }
-    }
-    dir = path.dirname(dir)
-  }
-  return path.join(startDir, 'node_modules')
-}
 
 export default async function start() {
   const cwd = process.cwd()
@@ -37,28 +17,20 @@ export default async function start() {
   }
 
   const veslxRoot = new URL('../..', import.meta.url).pathname;
-  const nodeModulesDir = findNodeModulesDir(veslxRoot)
+
+  // Resolve content directory relative to user's cwd (where config lives)
+  const contentDir = path.isAbsolute(config.dir)
+    ? config.dir
+    : path.resolve(cwd, config.dir);
 
   const server = await preview({
     root: veslxRoot,
     configFile: new URL('../../vite.config.ts', import.meta.url).pathname,
     plugins: [
-      veslxPlugin(config.dir)
+      veslxPlugin(contentDir)
     ],
-    // resolve: {
-    //   // Tell Vite to look for modules in the found node_modules directory
-    //   modules: [nodeModulesDir, 'node_modules'],
-    // },
-    // server: {
-    //   fs: {
-    //     // Allow serving from the parent node_modules
-    //     allow: [veslxRoot, nodeModulesDir, cwd],
-    //   },
-    // },
   })
 
-  // await server.listen()
-
   server.printUrls()
   server.bindCLIShortcuts({ print: true })
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "veslx",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "type": "module",
   "bin": {
     "veslx": "bin/veslx.ts"

package/plugin/src/plugin.ts

@@ -2,7 +2,7 @@ import { type Plugin, type Connect } from 'vite'
 import path from 'path'
 import fs from 'fs'
 import { buildAll } from './lib'
-import chokidar from 'chokidar'
+import chokidar, { type FSWatcher } from 'chokidar'
 import type { IncomingMessage, ServerResponse } from 'http'
 
 /**
@@ -24,18 +24,21 @@ function copyDirSync(src: string, dest: string) {
   }
 }
 
-export default function contentPlugin(inputDir: string): Plugin {
+export default function contentPlugin(contentDir: string): Plugin {
 
-  if (!inputDir) {
+  if (!contentDir) {
     throw new Error('Content directory must be specified.')
   }
 
-  // Resolve dir to absolute path from user's cwd
-  const dir = path.isAbsolute(inputDir) ? inputDir : path.resolve(process.cwd(), inputDir)
+  if (!path.isAbsolute(contentDir)) {
+    throw new Error(`Content directory must be an absolute path, got: ${contentDir}`)
+  }
+
+  const dir = contentDir
 
   const buildFn = () => buildAll([dir])
 
-  let watchers: chokidar.FSWatcher[] = []
+  let watchers: FSWatcher[] = []
 
   // Server middleware for serving content files
   const urlToDir = new Map<string, string>()

package/vite.config.ts

@@ -53,9 +53,6 @@ export default defineConfig({
     host: '0.0.0.0',
     port: process.env.PORT ? parseInt(process.env.PORT, 10) : 3000,
     strictPort: true,
-    fs: {
-      allow: ['..', '../..'],
-    },
     allowedHosts: true,
   },
   build: {