Markdown Comments

Version-Controlled Comments,
Inside Your Rendered Markdown

Highlight text and collaborate directly on Markdown documentation. Stored locally in companion YAML files, enabling native Git review, grep, and synchronization.

doc_collaboration.md
doc_collaboration.md

Project Architecture

This project implements collaborative tools.

The frontend relies on responsive vanilla styles for modern performance.

YAML companion files sync changes seamlessly.

Comments ● ● ●
D
dev_lead 10m ago
Should we also add Tailwind CSS config options?

Why Markdown Comments?

A modern approach to documentation feedback.
Keep reviews alongside your content.

Companion File Persistence

Comments are stored in <filename>.comments.yml right next to your Markdown. No centralized database, no lock-in. Track reviews alongside content in Git branches.

Fuzzy Anchoring Cascade

Robustly anchors comments to text paragraphs. If you edit, move, or modify lines, our cascade matching locates the comment block safely without losing data.

Threaded Conversations

Support for nested replies, emoji reactions, and thread status (Open / Resolved) to manage feedback resolution loops within your document panels.

Integrations for Your Workflow

Use Markdown Comments natively in your favorite editors and GitHub.

VS Code, Cursor & Antigravity

A fully featured workspace extension. Access comments in a native side panel, highlight selections to anchor thoughts, and edit files side-by-side.

  • Interactive side panel mapping comment threads to lines.
  • Command Palette action to scan for orphaned comments.
  • Robust configuration for reactions and pane widths.

GitHub Integration (Chrome Extension)

Collaborate natively on GitHub PRs. Renders a dedicated "Comments" workspace and lets you comment inline on Markdown diff lines using direct Git commits.

  • Automated PR tab integration alongside code review.
  • Direct commits back to target repository or comments branches.
  • Supports Personal Access Tokens (PAT) for rate-limit bypass.

Obsidian Plugin

Bring native collaboration to your personal knowledge base. Right-click any block in Live Preview or Reading Mode to write comment logs in companion files.

  • Integrates seamlessly with Obsidian's right sidebar ribbon.
  • Supports Obsidian Sync, Dropbox, and Git vault backup.
  • Custom Author fallback using Git username configs.
Setup Instructions