Review Markdown files in your browser with inline comments
npm install md-review!demo
A CLI tool for reviewing Markdown files with inline comments.
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
``sh`
npm install -g md-review
`sh`
md-review [options] # Browse all markdown files in current directory
md-review
md-review
`sh`
-p, --port
--no-open Do not open browser automatically
-h, --help Show this help message
-v, --version Show version number
`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
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"
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 changesEscape
4. Press or click "Cancel" to discard changes
- Cmd/Ctrl+Enter - Submit/Save commentEscape
- - Cancel editingCmd+K` - Focus search bar (in directory mode)
-
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.