wiki-viewer 1.0.0

package/.next/standalone/README.md

@@ -0,0 +1,283 @@
+<div align="center">
+  <img src="public/logo.svg" width="80" height="80" alt="wiki-viewer logo" />
+  <h1>wiki-viewer</h1>
+  <p><strong>Browse, read, and edit your local files from a clean web UI.</strong></p>
+  <p>
+    Markdown · PDF · Office docs · Notebooks · Images · Code · and more
+  </p>
+
+  <p>
+    <!-- npm badge placeholder — will activate once package is published -->
+    <!-- <a href="https://www.npmjs.com/package/wiki-viewer"><img src="https://img.shields.io/npm/v/wiki-viewer" alt="npm version" /></a> -->
+    <img src="https://img.shields.io/badge/npm-not%20yet%20published-lightgrey" alt="npm not yet published" />
+    <img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen" alt="Node.js ≥18" />
+    <img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT license" />
+  </p>
+</div>
+
+---
+
+## What is it?
+
+**wiki-viewer** is a zero-config local file browser you run from your terminal. It starts a small web server and lets you navigate, read, and edit any directory on your machine — right from the browser.
+
+No cloud. No accounts. No syncing. Your files stay on your machine.
+
+---
+
+## Features
+
+| Category         | What's included                                                                                                                                                                                    |
+| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **File viewers** | Markdown (with frontmatter), PDF, images (PNG / JPG / SVG / WebP), video & audio, CSV (table view), source code (syntax highlighting), DOCX, XLSX, PPTX, Jupyter notebooks, Mermaid diagrams, HTML |
+| **Editor**       | Rich TipTap editor for Markdown files                                                                                                                                                              |
+| **File ops**     | Upload files, create folders, delete, drag-to-move                                                                                                                                                 |
+| **Wiki links**   | `[[page-name]]` links between Markdown files                                                                                                                                                       |
+| **Dark mode**    | System-aware, with manual toggle                                                                                                                                                                   |
+| **HTTPS**        | Required for remote access — self-signed cert (OpenSSL) or trusted cert (mkcert); runs as HTTPS proxy in front of the internal HTTP server                                                         |
+
+---
+
+## Quick start
+
+> **Note:** The npm package is not yet published. Use the [dev setup](#-dev-setup) below to run locally from source. The `npx` commands below will work once the package is on npm.
+
+```bash
+# Point it at a directory
+npx wiki-viewer ~/notes
+
+# No directory? Pick one in the browser
+npx wiki-viewer
+
+# Running on a remote machine? HTTPS is required (see note below)
+npx wiki-viewer ~/notes --https
+```
+
+Then open **http://localhost:3000** (or **https://localhost:3000** with `--https`).
+
+> ⚠️ **Running on a remote host?** The app must be accessed over **HTTPS** — not plain HTTP — or several features will silently break (PDF viewer, service workers, and anything that requires a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts)). Use `--https` or put it behind a reverse proxy that handles TLS. Plain HTTP only works correctly on `localhost`.
+
+### Options
+
+```
+wiki-viewer [directory] [options]
+
+  directory            Directory to serve  (optional — pick in the browser if omitted)
+
+Options:
+  -p, --port <port>   Port to listen on   (default: 3000)
+  -H, --host <host>   Host to bind to     (default: localhost)
+      --https         Enable HTTPS        (self-signed cert, required for service workers on remote)
+  -h, --help          Show this help message
+```
+
+**Examples:**
+
+```bash
+# Custom port
+npx wiki-viewer ~/notes -p 8080
+
+# Bind to all interfaces (accessible on your local network)
+npx wiki-viewer ~/notes -H 0.0.0.0
+
+# HTTPS on a custom port
+npx wiki-viewer ~/notes --https -p 8443
+```
+
+---
+
+## 🔧 Dev setup
+
+Follow these steps to run wiki-viewer from source for local development or contribution.
+
+### Prerequisites
+
+- **Node.js** ≥ 18 — [nodejs.org](https://nodejs.org)
+- **pnpm** — [pnpm.io/installation](https://pnpm.io/installation)
+  ```bash
+  npm install -g pnpm
+  ```
+
+### 1 · Clone the repo
+
+```bash
+git clone https://github.com/anh-chu/wiki-viewer.git
+cd wiki-viewer
+```
+
+### 2 · Install dependencies
+
+```bash
+pnpm install
+```
+
+### 3 · Start the dev server
+
+```bash
+# Serve a directory
+ROOT_DIR=~/notes pnpm dev
+
+# No directory — pick one in the browser
+pnpm dev
+
+# HTTPS dev mode (uses Next.js experimental HTTPS)
+ROOT_DIR=~/notes pnpm dev:https
+```
+
+Open **http://localhost:3000**.
+
+The dev server supports **hot reload** — changes to source files are reflected instantly.
+
+### Available scripts
+
+| Command          | Description                              |
+| ---------------- | ---------------------------------------- |
+| `pnpm dev`       | Start Next.js development server         |
+| `pnpm dev:https` | Start dev server with experimental HTTPS |
+| `pnpm build`     | Build production bundle                  |
+| `pnpm start`     | Start production server (after build)    |
+| `pnpm wiki`      | Run the CLI entry point (after build)    |
+
+### Environment variables
+
+| Variable   | Description              | Default               |
+| ---------- | ------------------------ | --------------------- |
+| `ROOT_DIR` | Directory to serve       | `~/wiki-viewer-files` |
+| `PORT`     | Port to listen on        | `3000`                |
+| `HOSTNAME` | Host / interface to bind | `localhost`           |
+
+---
+
+## 🚀 Local deployment (self-hosted)
+
+Want to run wiki-viewer as a persistent server on your machine or a home server? Here's how.
+
+### Option A — Build and run directly
+
+```bash
+# 1. Clone & install
+git clone https://github.com/anh-chu/wiki-viewer.git
+cd wiki-viewer
+pnpm install
+
+# 2. Build the production bundle
+pnpm build
+
+# 3. Copy static assets into the standalone output (required step)
+cp -r .next/static .next/standalone/.next/static
+cp -r public .next/standalone/public
+
+# 4. Start the server
+ROOT_DIR=/path/to/your/files node .next/standalone/server.js
+```
+
+Or use the CLI wrapper (which handles the above automatically):
+
+```bash
+node bin/wiki-viewer.js /path/to/your/files
+```
+
+### Option B — Run with PM2 (auto-restart on crash / reboot)
+
+```bash
+npm install -g pm2
+
+# Start and name the process
+pm2 start bin/wiki-viewer.js \
+  --name wiki-viewer \
+  --node-args="" \
+  -- /path/to/your/files --port 3000
+
+# Save so it auto-starts on reboot
+pm2 save
+pm2 startup   # follow the printed instructions
+```
+
+### Option C — systemd service (Linux)
+
+Create `/etc/systemd/system/wiki-viewer.service`:
+
+```ini
+[Unit]
+Description=wiki-viewer
+After=network.target
+
+[Service]
+Type=simple
+User=YOUR_USER
+WorkingDirectory=/home/YOUR_USER/wiki-viewer
+ExecStart=/usr/bin/node bin/wiki-viewer.js /path/to/your/files --port 3000 --host 0.0.0.0
+Restart=on-failure
+Environment=NODE_ENV=production
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Then enable and start it:
+
+```bash
+sudo systemctl daemon-reload
+sudo systemctl enable wiki-viewer
+sudo systemctl start wiki-viewer
+sudo systemctl status wiki-viewer
+```
+
+### HTTPS on a remote server
+
+> ⚠️ **HTTPS is required when wiki-viewer is not on `localhost`.** Browsers restrict several APIs (service workers, PDF.js, and other [secure-context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) features) to HTTPS-only origins. Accessing wiki-viewer over plain HTTP on a remote host will silently break parts of the UI.
+
+**How it works under the hood:** `--https` does not make the Next.js server itself speak TLS. Instead it:
+
+1. Starts the Next.js standalone server on a random internal HTTP port (`127.0.0.1:XXXXX`)
+2. Starts an HTTPS reverse proxy on the user-facing port that forwards all traffic to the internal server
+
+So the chain is always: **browser → HTTPS proxy → internal HTTP server**. This is why `--https` is the correct flag and not a plain HTTP URL even in "HTTPS mode".
+
+**Certificate generation** (automatic, stored at `~/.wiki-viewer/certs/`):
+
+- If **mkcert** is installed → locally-trusted cert (no browser warning)
+- Otherwise → OpenSSL self-signed cert (browser warns once — click through)
+
+```bash
+node bin/wiki-viewer.js /path/to/your/files --https --port 443 --host 0.0.0.0
+```
+
+> **Tip for production:** Use a real reverse proxy (nginx / Caddy) with a proper TLS certificate instead of `--https`. Configure it to proxy to wiki-viewer's plain HTTP port, and wiki-viewer will work correctly behind it — no `--https` flag needed.
+
+---
+
+## Project structure
+
+```
+wiki-viewer/
+├── bin/
+│   └── wiki-viewer.js      CLI entry point
+├── src/
+│   ├── app/                Next.js app router pages & API routes
+│   ├── components/         React components (viewer, editor, sidebar…)
+│   ├── lib/                File system helpers, parsers, utilities
+│   ├── stores/             Zustand state stores
+│   └── types/              Shared TypeScript types
+├── public/
+│   └── logo.svg
+├── next.config.ts
+└── package.json
+```
+
+---
+
+## Contributing
+
+1. Fork the repo and create a branch: `git checkout -b my-feature`
+2. Make your changes
+3. Test with `ROOT_DIR=~/notes pnpm dev`
+4. Open a pull request
+
+Bug reports and feature requests welcome via [GitHub Issues](https://github.com/anh-chu/wiki-viewer/issues).
+
+---
+
+## License
+
+MIT © [anh-chu](https://github.com/anh-chu)

package/.next/standalone/bin/wiki-viewer.js

@@ -0,0 +1,158 @@
+#!/usr/bin/env node
+import { spawn, execSync } from "node:child_process";
+import { createServer as createHttpsServer } from "node:https";
+import { createServer as createHttpServer, request as httpRequest } from "node:http";
+import { createServer as createNetServer } from "node:net";
+import { readFileSync, mkdirSync, existsSync } from "node:fs";
+import path from "node:path";
+import os from "node:os";
+import { fileURLToPath } from "node:url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const appRoot = path.resolve(__dirname, "..");
+const serverJs = path.join(appRoot, ".next", "standalone", "server.js");
+
+function printUsage() {
+  console.error("Usage: wiki-viewer [directory] [options]");
+  console.error("");
+  console.error("  directory            Directory to serve (optional — pick in browser if omitted)");
+  console.error("");
+  console.error("Options:");
+  console.error("  -p, --port <port>   Port to listen on (default: 3000)");
+  console.error("  -H, --host <host>   Host to bind to (default: localhost)");
+  console.error("  --https             Enable HTTPS (self-signed cert, enables service workers)");
+  console.error("");
+  console.error("Examples:");
+  console.error("  wiki-viewer ~/notes");
+  console.error("  wiki-viewer ~/notes --https");
+  console.error("  wiki-viewer ~/notes -p 8080 -H 0.0.0.0");
+}
+
+if (!existsSync(serverJs)) {
+  console.error("Error: pre-built server not found at", serverJs);
+  console.error("This is a bug – please report it at https://github.com/anh-chu/wiki-viewer/issues");
+  process.exit(1);
+}
+
+const args = process.argv.slice(2);
+
+if (args.includes("--help") || args.includes("-h")) {
+  printUsage();
+  process.exit(0);
+}
+
+const rootDir = args.find((a) => !a.startsWith("-"));
+let port = process.env.PORT ?? "3000";
+let host = process.env.HOSTNAME ?? "localhost";
+let useHttps = false;
+
+for (let i = 0; i < args.length; i++) {
+  const a = args[i];
+  if (a === "-p" || a === "--port") port = args[++i] ?? port;
+  else if (a === "-H" || a === "--host") host = args[++i] ?? host;
+  else if (a === "--https") useHttps = true;
+}
+
+const resolvedRoot = rootDir ? path.resolve(rootDir) : null;
+
+// ── HTTPS cert generation ──────────────────────────────────────────────────
+
+function ensureCerts() {
+  const dir = path.join(os.homedir(), ".wiki-viewer", "certs");
+  mkdirSync(dir, { recursive: true });
+  const keyPath = path.join(dir, "key.pem");
+  const certPath = path.join(dir, "cert.pem");
+  if (existsSync(keyPath) && existsSync(certPath)) {
+    return { key: readFileSync(keyPath), cert: readFileSync(certPath) };
+  }
+  // Try mkcert (trusted), fall back to openssl (self-signed)
+  try {
+    execSync("mkcert -version", { stdio: "ignore" });
+    execSync(`mkcert -install 2>/dev/null; mkcert -key-file "${keyPath}" -cert-file "${certPath}" localhost 127.0.0.1 "${host}"`, { stdio: "pipe" });
+    console.log("🔒  Trusted cert via mkcert");
+  } catch {
+    try {
+      execSync(
+        `openssl req -x509 -newkey rsa:2048 -keyout "${keyPath}" -out "${certPath}" -days 825 -nodes -subj "/CN=localhost"`,
+        { stdio: "ignore" },
+      );
+      console.log("🔒  Self-signed cert (browser will warn once — click through)");
+    } catch {
+      console.error("Error: --https requires mkcert or openssl");
+      process.exit(1);
+    }
+  }
+  return { key: readFileSync(keyPath), cert: readFileSync(certPath) };
+}
+
+// ── free port helper ───────────────────────────────────────────────────────
+
+function freePort() {
+  return new Promise((resolve) => {
+    const s = createNetServer();
+    s.listen(0, "127.0.0.1", () => {
+      const { port: p } = s.address();
+      s.close(() => resolve(p));
+    });
+  });
+}
+
+// ── start ──────────────────────────────────────────────────────────────────
+
+async function start() {
+  if (resolvedRoot) {
+    console.log(`📂  ${resolvedRoot}`);
+  } else {
+    console.log("📂  No directory specified — open the browser to choose one");
+  }
+
+  // When HTTPS is requested, run the standalone server on a random internal
+  // HTTP port and stand up an HTTPS reverse-proxy on the user-facing port.
+  const internalPort = useHttps ? String(await freePort()) : port;
+  const internalHost = "127.0.0.1";
+
+  const child = spawn(process.execPath, [serverJs], {
+    cwd: path.join(appRoot, ".next", "standalone"),
+    stdio: "inherit",
+    env: {
+      ...process.env,
+      ...(resolvedRoot ? { ROOT_DIR: resolvedRoot } : {}),
+      PORT: internalPort,
+      HOSTNAME: internalHost,
+    },
+  });
+
+  child.on("exit", (code) => process.exit(code ?? 0));
+
+  if (useHttps) {
+    const { key, cert } = ensureCerts();
+
+    // Simple HTTPS → HTTP proxy
+    const proxy = createHttpsServer({ key, cert }, (req, res) => {
+      const options = {
+        hostname: internalHost,
+        port: Number(internalPort),
+        path: req.url,
+        method: req.method,
+        headers: req.headers,
+      };
+      const upstream = httpRequest(options, (upRes) => {
+        res.writeHead(upRes.statusCode, upRes.headers);
+        upRes.pipe(res);
+      });
+      upstream.on("error", () => res.destroy());
+      req.pipe(upstream);
+    });
+
+    // Wait a moment for the standalone server to bind before starting proxy
+    setTimeout(() => {
+      proxy.listen(Number(port), host, () => {
+        console.log(`🌐  https://${host}:${port}`);
+      });
+    }, 1_000);
+  } else {
+    console.log(`🌐  http://${host}:${port}`);
+  }
+}
+
+start();

package/.next/standalone/next.config.ts

@@ -0,0 +1,11 @@
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  output: "standalone",
+  experimental: {
+    optimizePackageImports: ["lucide-react"],
+  },
+  allowedDevOrigins: ['devvm']
+};
+
+export default nextConfig;

package/.next/standalone/package.json

@@ -0,0 +1,120 @@
+{
+  "name": "wiki-viewer",
+  "version": "1.0.0",
+  "description": "Local file viewer and wiki — view markdown, HTML, PDFs, notebooks, office docs, and more from any directory",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "wiki-viewer": "bin/wiki-viewer.js"
+  },
+  "files": [
+    "bin",
+    ".next/standalone"
+  ],
+  "scripts": {
+    "dev": "next dev",
+    "dev:https": "next dev --experimental-https",
+    "build": "next build",
+    "start": "next start",
+    "wiki": "node bin/wiki-viewer.js",
+    "prepublishOnly": "npm run build && cp -r .next/static .next/standalone/.next/static && cp -r public .next/standalone/public"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "wiki",
+    "markdown",
+    "viewer",
+    "notes",
+    "local",
+    "cli"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anh-chu/wiki-viewer.git"
+  },
+  "dependencies": {
+    "chokidar": "^5.0.0",
+    "undici": "^8.3.0"
+  },
+  "devDependencies": {
+    "@radix-ui/react-collapsible": "^1.1.12",
+    "@radix-ui/react-context-menu": "^2.2.16",
+    "@radix-ui/react-dialog": "^1.1.15",
+    "@radix-ui/react-dropdown-menu": "^2.1.16",
+    "@radix-ui/react-label": "^2.1.8",
+    "@radix-ui/react-popover": "^1.1.15",
+    "@radix-ui/react-scroll-area": "^1.2.10",
+    "@radix-ui/react-select": "^2.2.6",
+    "@radix-ui/react-separator": "^1.1.8",
+    "@radix-ui/react-slot": "^1.2.4",
+    "@radix-ui/react-switch": "^1.2.6",
+    "@radix-ui/react-tabs": "^1.1.13",
+    "@radix-ui/react-toggle-group": "^1.1.11",
+    "@radix-ui/react-tooltip": "^1.2.8",
+    "@tailwindcss/typography": "^0.5.19",
+    "@tiptap/core": "^3.22.5",
+    "@tiptap/extension-bubble-menu": "^3.22.5",
+    "@tiptap/extension-code-block-lowlight": "^3.22.5",
+    "@tiptap/extension-color": "^3.22.5",
+    "@tiptap/extension-image": "^3.22.5",
+    "@tiptap/extension-link": "^3.22.5",
+    "@tiptap/extension-placeholder": "^3.22.5",
+    "@tiptap/extension-subscript": "^3.22.5",
+    "@tiptap/extension-superscript": "^3.22.5",
+    "@tiptap/extension-table": "^3.22.5",
+    "@tiptap/extension-table-cell": "^3.22.5",
+    "@tiptap/extension-table-header": "^3.22.5",
+    "@tiptap/extension-table-row": "^3.22.5",
+    "@tiptap/extension-task-item": "^3.22.5",
+    "@tiptap/extension-task-list": "^3.22.5",
+    "@tiptap/extension-text-align": "^3.22.5",
+    "@tiptap/extension-underline": "^3.22.5",
+    "@tiptap/pm": "^3.22.5",
+    "@tiptap/react": "^3.22.5",
+    "@tiptap/starter-kit": "^3.22.5",
+    "@tiptap/suggestion": "^3.22.5",
+    "@types/mdast": "^4.0.4",
+    "@types/node": "^22.15.0",
+    "@types/papaparse": "^5.5.2",
+    "@types/react": "19.2.14",
+    "@types/react-dom": "19.2.3",
+    "@types/turndown": "^5.0.6",
+    "autoprefixer": "^10.4.20",
+    "class-variance-authority": "^0.7.1",
+    "clsx": "^2.1.1",
+    "cmdk": "^1.1.1",
+    "docx-preview": "^0.3.7",
+    "gray-matter": "^4.0.3",
+    "hast-util-to-html": "^9.0.5",
+    "highlight.js": "^11.11.1",
+    "jszip": "^3.10.1",
+    "lowlight": "^3.3.0",
+    "lucide-react": "^0.525.0",
+    "mammoth": "^1.12.0",
+    "mermaid": "^11.14.0",
+    "next": "16.2.4",
+    "next-themes": "^0.4.6",
+    "papaparse": "^5.5.3",
+    "postcss": "^8.5.6",
+    "pptx-preview": "^1.0.7",
+    "react": "19.2.5",
+    "react-dom": "19.2.5",
+    "react-markdown": "^10.1.0",
+    "react-pdf": "^10.4.1",
+    "rehype-stringify": "^10.0.1",
+    "remark-gfm": "^4.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.2",
+    "sonner": "^2.0.7",
+    "tailwind-merge": "^3.3.0",
+    "tailwindcss": "^3.4.17",
+    "turndown": "^7.2.4",
+    "turndown-plugin-gfm": "^1.0.2",
+    "typescript": "^5.8.0",
+    "unified": "^11.0.5",
+    "xlsx": "^0.18.5",
+    "zustand": "^5.0.12"
+  }
+}