md-review 0.0.6 → 0.1.0

package/README.md

@@ -11,10 +11,12 @@ Comments can be copied and used as feedback for AI agents.
 
 - Display Markdown in its original format
 - Add comments to specific lines
+- Edit existing comments
 - Select files from tree view
 - Dark mode support (follows system preferences)
 - Resizable and collapsible sidebars
 - Click line numbers in comments to jump to corresponding content
+- Hot reload when markdown files change
 
 ## Install
 
@@ -27,6 +29,7 @@ npm install -g md-review
 ```sh
 md-review [options]              # Browse all markdown files in current directory
 md-review <file> [options]       # Preview a specific markdown file
+md-review <directory> [options]  # Browse markdown files in a specific directory
 ```
 
 ### Options
@@ -42,10 +45,43 @@ md-review <file> [options]       # Preview a specific markdown file
 
 ```sh
 md-review                        # Browse all markdown files in current directory
+md-review docs                   # Browse markdown files in docs directory
 md-review README.md              # Preview README.md
 md-review docs/guide.md --port 8080
 ```
 
+## Comment Management
+
+### Adding Comments
+
+1. Select text in the markdown preview
+2. Click the "Comment" button that appears
+3. Type your comment and press `Cmd/Ctrl+Enter` or click "Submit"
+
+### Editing Comments
+
+1. Click the edit icon (pencil) on any existing comment
+2. Modify the text in the textarea
+3. Press `Cmd/Ctrl+Enter` or click "Save" to save changes
+4. Press `Escape` or click "Cancel" to discard changes
+
+### Keyboard Shortcuts
+
+- `Cmd/Ctrl+Enter` - Submit/Save comment
+- `Escape` - Cancel editing
+- `Cmd+K` - Focus search bar (in directory mode)
+
+## Hot Module Replacement
+
+md-review automatically watches for changes to markdown files:
+
+- When you edit and save a markdown file, the preview updates automatically
+- No manual browser refresh needed
+- Works in both single file and directory browsing modes
+- File watching uses efficient Server-Sent Events (SSE)
+
+This makes it ideal for live editing workflows and quick iteration on documentation.
+
 ## License
 
 [MIT](./LICENSE)

package/bin/md-review.js

@@ -2,7 +2,7 @@
 
 import { spawn } from 'child_process';
 import { resolve, dirname } from 'path';
-import { existsSync, readFileSync } from 'fs';
+import { existsSync, readFileSync, statSync } from 'fs';
 import { fileURLToPath } from 'url';
 import mri from 'mri';
 
@@ -34,13 +34,13 @@ const args = mri(process.argv.slice(2), {
   alias: {
     p: 'port',
     h: 'help',
-    v: 'version'
+    v: 'version',
   },
   default: {
     port: '3030',
-    open: true
+    open: true,
   },
-  boolean: ['help', 'version', 'open']
+  boolean: ['help', 'version', 'open'],
 });
 
 // Help message
@@ -51,6 +51,7 @@ md-review - Review and annotate Markdown files with comments
 Usage:
   md-review [options]              Start in dev mode (browse all markdown files)
   md-review <file> [options]       Preview a specific markdown file (.md or .markdown)
+  md-review <directory> [options]  Browse markdown files in a specific directory
 
 Options:
   -p, --port <port>      Server port (default: 3030)
@@ -60,6 +61,7 @@ Options:
 
 Examples:
   md-review                        Start dev mode in current directory
+  md-review docs                   Browse markdown files in docs directory
   md-review README.md              Preview README.md
   md-review docs/guide.md --port 8080
 `);
@@ -88,13 +90,22 @@ if (file) {
     process.exit(1);
   }
 
-  if (!isMarkdownFile(filePath)) {
-    console.error(`Error: File must have .md or .markdown extension: ${filePath}`);
-    process.exit(1);
-  }
+  const stats = statSync(filePath);
+
+  if (stats.isDirectory()) {
+    // Dev mode with specified directory
+    process.env.BASE_DIR = filePath;
+    console.log(`Directory: ${filePath}`);
+  } else {
+    // File mode
+    if (!isMarkdownFile(filePath)) {
+      console.error(`Error: File must have .md or .markdown extension: ${filePath}`);
+      process.exit(1);
+    }
 
-  process.env.MARKDOWN_FILE_PATH = filePath;
-  console.log(`File: ${filePath}`);
+    process.env.MARKDOWN_FILE_PATH = filePath;
+    console.log(`File: ${filePath}`);
+  }
 } else {
   // Dev mode - browse all markdown files
   process.env.BASE_DIR = process.cwd();
@@ -108,7 +119,7 @@ console.log(`   Port: ${port}`);
 const serverProcess = spawn('node', ['server/index.js'], {
   cwd: packageRoot,
   stdio: ['inherit', 'pipe', 'inherit'],
-  env: process.env
+  env: process.env,
 });
 
 let serverReady = false;