skimmd 1.0.0 → 1.0.2

package/README.md

@@ -1,4 +1,4 @@
-# skimmd
+### skimmd
 
 **One command. Zero install. Your markdown, beautifully rendered.**
 
@@ -8,20 +8,20 @@ npx skimmd
 
 That's it. Browser opens. Your markdown files look like GitHub. Edit them live.
 
----
+* * *
 
 ## The Problem
 
 You're writing a README. You want to see how it looks on GitHub. Your options:
 
-1. Push to GitHub, refresh, fix typo, push again, refresh... (we've all been there)
-2. Install a 200MB Electron app
-3. Use VS Code's preview that looks nothing like GitHub
-4. Use `grip` but hit GitHub API rate limits
+1.  Push to GitHub, refresh, fix typo, push again, refresh... (we've all been there)
+2.  Install a 200MB Electron app
+3.  Use VS Code's preview that looks nothing like GitHub
+4.  Use `grip` but hit GitHub API rate limits
 
 **skimmd**: One command, works offline, looks like GitHub, updates as you type.
 
----
+* * *
 
 ## 30-Second Demo
 
@@ -34,64 +34,102 @@ Your browser opens. You see your README rendered beautifully. Now open that file
 
 No reload button. No refresh. Just save and see.
 
----
+### Dark Mode
+
+![Dark Mode](darkMode.png)
+
+### Light Mode
+
+![Light Mode](lightMode.png)
+
+* * *
 
 ## Features
 
 ### Live Reload
+
 Edit in VS Code, Vim, or any editor. Save. Browser updates. No plugins, no extensions, no configuration.
 
 ### Inline Editing
+
 Click "Edit" in the browser. Make changes. Hit Ctrl+S. **Saves directly to your .md file.** Your editor picks up the change. Round-trip editing.
 
 ### GitHub-Flavored Markdown
-- Tables render correctly
-- Task lists work (`- [x] like this`)
-- Syntax highlighting for 190+ languages
-- Fenced code blocks
-- Strikethrough, autolinks, all of it
+
+-   Tables render correctly
+-   Task lists work (`- [x] like this`)
+-   Syntax highlighting for 190+ languages
+-   Fenced code blocks
+-   Strikethrough, autolinks, all of it
 
 ### Dark Mode
+
 Light, Dark, or Auto (follows your system). Because it's 2024 and we're not animals.
 
 ### Browse Entire Folders
+
 ```bash
 npx skimmd ./docs
 ```
+
 Sidebar shows all your markdown files. Filter them. Jump between them. Table of contents auto-generated from headings.
 
----
+* * *
 
 ## Why Not Just Use...
 
-| Tool | The Problem |
-|------|-------------|
-| **VS Code Preview** | Doesn't look like GitHub. No live reload in browser. |
-| **grip** | Hits GitHub API. Rate limited. Requires auth for private repos. |
-| **Typora** | $15. Electron app. Doesn't look like GitHub. |
-| **MacDown** | macOS only. No live reload. Dated UI. |
-| **Obsidian** | Overkill for previewing a README. Different styling. |
-| **glow** | Terminal only. Can't share screen with non-terminal people. |
-| **peekmd** | Requires Bun. No editing. No live reload. |
+Tool
+
+The Problem
+
+**VS Code Preview**
+
+Doesn't look like GitHub. No live reload in browser.
+
+**grip**
+
+Hits GitHub API. Rate limited. Requires auth for private repos.
+
+**Typora**
+
+$15. Electron app. Doesn't look like GitHub.
+
+**MacDown**
+
+macOS only. No live reload. Dated UI.
+
+**Obsidian**
+
+Overkill for previewing a README. Different styling.
+
+**glow**
+
+Terminal only. Can't share screen with non-terminal people.
+
+**peekmd**
+
+Requires Bun. No editing. No live reload.
 
 **skimmd**: Works with Node (you already have it). Zero config. Live reload. Inline editing. Looks like GitHub.
 
----
+* * *
 
 ## Installation
 
 **Option 1: No install (recommended)**
+
 ```bash
 npx skimmd
 ```
 
 **Option 2: Global install**
+
 ```bash
 npm install -g skimmd
 skimmd
 ```
 
----
+* * *
 
 ## Usage
 
@@ -112,48 +150,50 @@ skimmd --port 8080
 skimmd --no-open
 ```
 
----
+* * *
 
 ## Keyboard Shortcuts
 
-| Shortcut | Action |
-|----------|--------|
-| `Ctrl/Cmd + S` | Save (when editing) |
-| `Ctrl/Cmd + K` | Focus file filter |
+Shortcut
+
+Action
+
+`Ctrl/Cmd + S`
+
+Save (when editing)
+
+`Ctrl/Cmd + K`
+
+Focus file filter
 
----
+* * *
 
 ## How It Works
 
-1. Starts a local Express server
-2. Watches your markdown files with chokidar
-3. Renders with `marked` (GitHub-flavored)
-4. Syntax highlighting with `highlight.js`
-5. Sends file changes via Server-Sent Events
-6. Browser updates without refresh
+1.  Starts a local Express server
+2.  Watches your markdown files with chokidar
+3.  Renders with `marked` (GitHub-flavored)
+4.  Syntax highlighting with `highlight.js`
+5.  Sends file changes via Server-Sent Events
+6.  Browser updates without refresh
 
 All local. Nothing leaves your machine. Works on a plane.
 
----
+* * *
 
 ## FAQ
 
-**Does it work offline?**
-Yes. Everything runs locally. No API calls.
+**Does it work offline?** Yes. Everything runs locally. No API calls.
 
-**Can I use it for a presentation?**
-Yes. Dark mode + clean UI + live reload = great for live coding demos.
+**Can I use it for a presentation?** Yes. Dark mode + clean UI + live reload = great for live coding demos.
 
-**Does it support Mermaid diagrams?**
-Not yet. PRs welcome.
+**Does it support Mermaid diagrams?** Not yet. PRs welcome.
 
-**What about MDX?**
-Just markdown for now. Keep it simple.
+**What about MDX?** Just markdown for now. Keep it simple.
 
-**Windows support?**
-Yes. Works anywhere Node.js runs.
+**Windows support?** Yes. Works anywhere Node.js runs.
 
----
+* * *
 
 ## Contributing
 
@@ -167,15 +207,13 @@ npm link
 skimmd ./docs
 ```
 
----
+* * *
 
 ## License
 
 MIT
 
----
+* * *
 
-<p align="center">
-  <b>Stop pushing to GitHub just to preview your README.</b><br>
-  <code>npx skimmd</code>
-</p>
+**Stop pushing to GitHub just to preview your README.**  
+`npx skimmd`

package/bin/skimmd.js

@@ -297,6 +297,129 @@ async function createServer(options) {
     }
   });
 
+  // Browse directories and files
+  app.get("/api/browse", async (req, res) => {
+    const browsePath = req.query.path || process.env.HOME || "/";
+    try {
+      const resolvedPath = path.resolve(browsePath);
+      const stats = await fsp.stat(resolvedPath);
+
+      if (!stats.isDirectory()) {
+        return res.status(400).json({ error: "Path is not a directory" });
+      }
+
+      const entries = await fsp.readdir(resolvedPath, { withFileTypes: true });
+      const items = [];
+
+      for (const entry of entries) {
+        // Skip hidden files/folders
+        if (entry.name.startsWith(".")) continue;
+
+        const fullPath = path.join(resolvedPath, entry.name);
+        const isDir = entry.isDirectory();
+        const ext = path.extname(entry.name).toLowerCase();
+        const isMarkdown = [".md", ".markdown", ".txt"].includes(ext);
+
+        // Only include directories and markdown files
+        if (isDir || isMarkdown) {
+          items.push({
+            name: entry.name,
+            path: fullPath,
+            isDirectory: isDir,
+          });
+        }
+      }
+
+      // Sort: directories first, then files, alphabetically
+      items.sort((a, b) => {
+        if (a.isDirectory && !b.isDirectory) return -1;
+        if (!a.isDirectory && b.isDirectory) return 1;
+        return a.name.localeCompare(b.name);
+      });
+
+      res.json({
+        current: resolvedPath,
+        parent: path.dirname(resolvedPath),
+        items,
+      });
+    } catch (error) {
+      res.status(500).json({ error: error instanceof Error ? error.message : "Failed to browse" });
+    }
+  });
+
+  // Open any markdown file by absolute path
+  app.get("/api/open-file", async (req, res) => {
+    const filePath = req.query.path;
+    if (!filePath || typeof filePath !== "string") {
+      return res.status(400).json({ error: "Missing file path" });
+    }
+
+    try {
+      const resolvedPath = path.resolve(filePath);
+      const stats = await fsp.stat(resolvedPath);
+
+      if (!stats.isFile()) {
+        return res.status(400).json({ error: "Path is not a file" });
+      }
+
+      const content = await fsp.readFile(resolvedPath, "utf-8");
+      const html = marked.parse(content);
+
+      res.json({
+        path: resolvedPath,
+        name: path.basename(resolvedPath),
+        content,
+        html,
+        metadata: {
+          size: stats.size,
+          modifiedAt: stats.mtime,
+          createdAt: stats.birthtime,
+        },
+      });
+    } catch (error) {
+      res.status(404).json({ error: error instanceof Error ? error.message : "File not found" });
+    }
+  });
+
+  // Save any markdown file by absolute path
+  app.put("/api/open-file", async (req, res) => {
+    const filePath = req.query.path;
+    const { content, html } = req.body || {};
+
+    if (!filePath || typeof filePath !== "string") {
+      return res.status(400).json({ error: "Missing file path" });
+    }
+
+    let finalContent = content;
+    if (typeof html === "string") {
+      finalContent = turndownService.turndown(html);
+    }
+    if (typeof finalContent !== "string") {
+      return res.status(400).json({ error: "Missing content" });
+    }
+
+    try {
+      const resolvedPath = path.resolve(filePath);
+      await fsp.writeFile(resolvedPath, finalContent, "utf-8");
+      const stats = await fsp.stat(resolvedPath);
+      const renderedHtml = marked.parse(finalContent);
+
+      res.json({
+        path: resolvedPath,
+        name: path.basename(resolvedPath),
+        content: finalContent,
+        html: renderedHtml,
+        metadata: {
+          size: stats.size,
+          modifiedAt: stats.mtime,
+          createdAt: stats.birthtime,
+        },
+      });
+    } catch (error) {
+      res.status(500).json({ error: error instanceof Error ? error.message : "Failed to save file" });
+    }
+  });
+
   app.use(express.static(path.join(__dirname, "..", "public")));
 
   app.get("*", (_req, res) => {
@@ -363,9 +486,23 @@ program
         }
       });
 
-      const shutdown = () => {
-        watcher.close();
+      const shutdown = async () => {
+        console.log("\nShutting down...");
+
+        // Close all SSE connections first
+        for (const client of sseClients) {
+          client.end();
+        }
+        sseClients.clear();
+
+        // Close file watcher (returns Promise in chokidar v5)
+        await watcher.close();
+
+        // Close server with timeout fallback
         server.close(() => process.exit(0));
+
+        // Force exit if server doesn't close within 2 seconds
+        setTimeout(() => process.exit(0), 2000);
       };
 
       process.on("SIGINT", shutdown);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skimmd",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Instant markdown preview in your browser. Zero config, GitHub-style rendering, inline editing.",
   "type": "module",
   "bin": {