md-review 0.0.6 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -11,10 +11,12 @@ Comments can be copied and used as feedback for AI agents.
|
|
|
11
11
|
|
|
12
12
|
- Display Markdown in its original format
|
|
13
13
|
- Add comments to specific lines
|
|
14
|
+
- Edit existing comments
|
|
14
15
|
- Select files from tree view
|
|
15
16
|
- Dark mode support (follows system preferences)
|
|
16
17
|
- Resizable and collapsible sidebars
|
|
17
18
|
- Click line numbers in comments to jump to corresponding content
|
|
19
|
+
- Hot reload when markdown files change
|
|
18
20
|
|
|
19
21
|
## Install
|
|
20
22
|
|
|
@@ -46,6 +48,35 @@ md-review README.md # Preview README.md
|
|
|
46
48
|
md-review docs/guide.md --port 8080
|
|
47
49
|
```
|
|
48
50
|
|
|
51
|
+
## Comment Management
|
|
52
|
+
|
|
53
|
+
### Adding Comments
|
|
54
|
+
1. Select text in the markdown preview
|
|
55
|
+
2. Click the "Comment" button that appears
|
|
56
|
+
3. Type your comment and press `Cmd/Ctrl+Enter` or click "Submit"
|
|
57
|
+
|
|
58
|
+
### Editing Comments
|
|
59
|
+
1. Click the edit icon (pencil) on any existing comment
|
|
60
|
+
2. Modify the text in the textarea
|
|
61
|
+
3. Press `Cmd/Ctrl+Enter` or click "Save" to save changes
|
|
62
|
+
4. Press `Escape` or click "Cancel" to discard changes
|
|
63
|
+
|
|
64
|
+
### Keyboard Shortcuts
|
|
65
|
+
- `Cmd/Ctrl+Enter` - Submit/Save comment
|
|
66
|
+
- `Escape` - Cancel editing
|
|
67
|
+
- `Cmd+K` - Focus search bar (in directory mode)
|
|
68
|
+
|
|
69
|
+
## Hot Module Replacement
|
|
70
|
+
|
|
71
|
+
md-review automatically watches for changes to markdown files:
|
|
72
|
+
|
|
73
|
+
- When you edit and save a markdown file, the preview updates automatically
|
|
74
|
+
- No manual browser refresh needed
|
|
75
|
+
- Works in both single file and directory browsing modes
|
|
76
|
+
- File watching uses efficient Server-Sent Events (SSE)
|
|
77
|
+
|
|
78
|
+
This makes it ideal for live editing workflows and quick iteration on documentation.
|
|
79
|
+
|
|
49
80
|
## License
|
|
50
81
|
|
|
51
82
|
[MIT](./LICENSE)
|