Markdown Comment provides PDF-like commenting and replying functionality for Markdown files. Best of all, it makes no changes to the Markdown file itself, keeping your content clean and pure.
While Markdown files are increasingly used for documentation and AI interactions, this extension smartly manages reviews and comments, bridging the gap between developers and non-technical stakeholders.
[!NOTE]
Comment data is persisted in a separate metadata file (your-md-file.meta.jsonl).
For detailed file specifications, please refer to the following:
File Specification
[!NOTE]
Future plans include browser extensions for viewers and editors to further expand accessibility.
✨ Key Features
Markdown Preview Integration: View comments directly within the native preview with rich highlighting.
Improved Highlighting: Supports nested comment ranges and shows comment content on hover.
Sidebar Sync: Seamlessly navigate between the preview highlights and the comment sidebar.
Robust Rendering: Comment highlights no longer break image tags or other complex Markdown structures.
Dedicated Editor: Edit Markdown with overlay comments.
Organization: Tree and Table views for efficient comment management.
Feature
Screenshot
Add Comment
Preview
Inline Editor
Tree Views
Table Views
Edit Tags
🚀 Usage
Open a Markdown file (.md) in VS Code.
Launch the Command Palette (Ctrl+Shift+P / Cmd+Shift+P).
SelectMarkdown Comment: Open preview to the Side.
Comment: In the preview, select text, right-click, and choose [Add Comment].
Manage: Click the "💬 Comments" button in the preview to open the sidebar. Click a comment in the sidebar to jump to the highlighted text, or click a highlight to reveal it in the sidebar.
💡 Commenting Highlights
Tagging: Categorize comments with custom tags (manage via QuickPick).
Column Reordering: Organize your view by dragging and dropping table headers.
Threading: Post unlimited replies to create focused discussion threads.
Status Tracking: Mark comments as Open, Resolved, etc., to track progress.
Rich Tooltips: Hover over any highlighted text in the preview to see the original comment and its author instantly.
Synchronized View: The preview highlights and the sidebar are fully synchronized, making it easy to track conversations across large documents.
⌨️ Commands
Command
Title
Description
markdown-comment.openPreview
Open Preview
Opens the dedicated preview with comments.
markdown-comment.openPreviewToSide
Open Preview to the Side
Opens the preview to the side.
markdown-comment.showCommentTable
Show Comment Table
Opens the Comment Table view.
🔧 Technical Details
Non-Invasive: Comments are stored in a sidecar file (filename.meta.jsonl).
Clean Data: Your original Markdown files remain untouched.
⚙️ Configuration
Customize the extension via VS Code Settings:
Setting
Type
Default
Description
markdownComment.commentsTable.columns
array
["lineNo", ...]
Columns to display in the Comment Table (lineNo, content, status, etc.).
markdownComment.commentsTable.columnWidths
object
{...}
Pixel widths for table columns.
markdownComment.defaultAuthor
string
""
Default author name (defaults to system user if empty).
🤝 Contribution & Support
Contributions are welcome! If you find this extension useful, please consider supporting its development.
