viteboard 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 ViteBoard Contributors
+
+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

@@ -0,0 +1,136 @@
+# ViteBoard
+
+A local-first documentation workspace and infinite-canvas whiteboard. Markdown docs, boards, and structured capability specs — all plain files on disk, tracked by git.
+
+**Zero runtime dependencies.** Built entirely in vanilla TypeScript with Vite.
+
+## Install
+
+```bash
+npm install -g viteboard
+```
+
+Then run from any directory:
+
+```bash
+viteboard
+```
+
+Or run without installing:
+
+```bash
+npx viteboard
+```
+
+Or with pnpm:
+
+```bash
+pnpm dlx viteboard
+```
+
+ViteBoard opens in your browser. Click **Add Repo** in the sidebar, pick any local project directory, and ViteBoard discovers all `docs/` folders and mounts them in the sidebar.
+
+## Development
+
+To work on ViteBoard itself:
+
+```bash
+git clone https://gitlab.com/ajsib/viteboard.git
+cd viteboard
+npm install
+npm run dev
+```
+
+## What It Does
+
+ViteBoard is a local documentation tool that runs alongside your codebase. Point it at a project directory and it finds every `docs/` folder, giving you a workspace to write, organize, and browse documentation — all stored as plain files that git tracks naturally.
+
+### Docs
+
+Write markdown files inside any `docs/` directory. ViteBoard renders them with full markdown support: headings, lists, tables, code blocks, images, and links. Edit inline or in an integrated editor.
+
+### Boards
+
+Infinite-canvas whiteboards saved as `.board.json` files next to your docs. Create sticky notes, shapes, arrows, text, images, tasks, and frames. Boards are small, diffable, and git-native.
+
+Board regions can be embedded directly into markdown documents using fenced code blocks.
+
+### Capabilities
+
+Structured markdown specs with YAML frontmatter (title, summary, tags). Build a cart of specs and copy them as a combined prompt for AI workflows.
+
+### Search
+
+Full-text search across every doc and capability in every registered project. `Cmd/Ctrl K` to open from anywhere.
+
+## Project Structure
+
+```
+your-project/
+  frontend/
+    src/
+    docs/                  <- ViteBoard discovers this
+      index.md
+      guides/
+        getting-started.md
+      boards/
+        architecture.board.json
+      capabilities/
+        auth-flow.md
+      assets/
+        screenshot.png
+  api/
+    docs/                  <- And this
+      endpoints.md
+  backend/                 <- No docs/ yet (create one via View: Raw)
+```
+
+Each `docs/` folder becomes a content root. ViteBoard reads and writes files directly to disk. Git in your project is the source of truth.
+
+## Navigation
+
+### View: Docs (default)
+
+The sidebar shows only your `docs/` folders and their contents. Clean, focused, no noise from the rest of the project filesystem.
+
+### View: Raw
+
+Toggle via the three-dot menu on any project header. Shows the full directory tree with non-docs directories subtly muted. Right-click any directory to create a `docs/` folder inside it. Once created, toggle back to Docs view and the new root appears immediately.
+
+### Breadcrumbs
+
+Every page shows its full path as clickable breadcrumbs. Each directory segment links to a wiki page showing the contents of that level — docs, boards, capabilities, and subdirectories.
+
+### Shared Links
+
+Copy any URL from the address bar. Links are stable and resolve correctly when the same project is registered in the workspace.
+
+## Sidebar Actions
+
+- **Right-click a directory** inside `docs/` to create docs, boards, capabilities, or subdirectories
+- **Right-click a file** to open, edit, rename, or delete
+- **Drag and drop** files and directories to reorganize
+- **Three-dot menu** on project headers for View: Raw/Docs toggle, wiki, and project actions
+
+## Workspace
+
+Developer-specific workspace settings (which projects are registered) live in `.workspace/` and should be gitignored. The workspace file stores only absolute paths to project roots.
+
+## Building
+
+```bash
+npm run build     # Type-check + bundle to dist/
+npm run preview   # Preview the production build
+```
+
+## Tech
+
+- **Vite** — dev server and build tool
+- **TypeScript** — all source code, zero JavaScript
+- **Canvas API** — infinite-canvas board rendering (no libraries)
+- **Custom Vite plugin** — serves as the backend, handling file I/O and workspace management
+- **Hash-based routing** — works as static files, no page reloads
+
+## License
+
+MIT

package/bin/viteboard.mjs

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+
+import { createServer } from "vite";
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import fs from "node:fs";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const packageRoot = path.resolve(__dirname, "..");
+
+// The user's working directory — where .workspace/ and projects live
+const userCwd = process.cwd();
+
+const port = parseInt(process.env.PORT || "5173", 10);
+const host = process.env.HOST || "localhost";
+
+async function main() {
+  // Check if we're running from the source repo (dev mode) or as an installed package
+  const hasSourceIndex = fs.existsSync(path.join(packageRoot, "index.html"));
+  const hasDist = fs.existsSync(path.join(packageRoot, "dist", "index.html"));
+
+  if (hasSourceIndex) {
+    // Dev mode or running from source — use Vite dev server
+    const server = await createServer({
+      root: packageRoot,
+      configFile: path.join(packageRoot, "vite.config.ts"),
+      server: { port, host, open: true },
+    });
+    await server.listen();
+    server.printUrls();
+  } else if (hasDist) {
+    // Installed as a package — serve the pre-built dist with the API plugin
+    // We need to dynamically import the config since it may be .ts
+    const { default: configFn } = await import(path.join(packageRoot, "vite.config.ts"));
+    const config = typeof configFn === "function" ? configFn({}) : configFn;
+    const plugins = Array.isArray(config.plugins) ? config.plugins : [];
+
+    const server = await createServer({
+      root: path.join(packageRoot, "dist"),
+      plugins,
+      server: { port, host, open: true },
+    });
+    await server.listen();
+    server.printUrls();
+  } else {
+    console.error("ViteBoard: Could not find index.html or dist/. Is the package installed correctly?");
+    process.exit(1);
+  }
+}
+
+console.log(`
+  ViteBoard — Local documentation workspace
+  Working directory: ${userCwd}
+`);
+
+main().catch((err) => {
+  console.error("Failed to start ViteBoard:", err);
+  process.exit(1);
+});