Markdown Comments

Stop Siloing Docs.
Bring Them Home.

Docs and comments live in your Git repository. With one shared backend, developers in agentic IDEs like Cursor and VS Code collaborate seamlessly with business reviewers on rendered web docs, without SaaS lock in or PR overhead.

doc_collaboration.md
doc_collaboration.md

Project Architecture

This project implements collaborative tools.

The frontend relies on responsive vanilla styles for modern performance.

GitHub backend stores comments without cluttering your git tree.

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

Experience Markdown Comments Across Frameworks

⚡ Instant Try

Instant Demo

Zero-friction browser demo without GitHub sign-in, OAuth consent, or repository write permissions. Uses simulated personas and local storage.

Live Demo

Plain HTML

Embeddable drop-in JS snippet that enables inline comments committing directly to GitHub custom git refs.

Live Demo

Astro & Starlight

Native Starlight integration with interactive margin pins, floating bubble selection, and GitHub Device Flow.

Coming Soon

Docusaurus

React plugin bringing effortless inline document comments and team review loops to Docusaurus sites.

Coming Soon

VitePress

Vue & Vite-powered documentation theme integration designed for ultra-fast doc workflows.

Coming Soon

Next.js

React Server Component (RSC) compatible documentation component with Fumadocs and Nextra support.

Coming Soon

Hugo

Lightweight shortcode integration for blazing-fast Go-based static documentation sites.

Coming Soon

MkDocs

Python & Material for MkDocs extension providing inline feedback and review directly on project docs.

AI Orchestrated Docs.
Human Orchestrated Comments.

AI agents maintain markdown in Git, while humans review and discuss rendered pages. With one shared Git backend, engineering and business teams stay synchronized across IDEs and browsers without third party silos.

The Problem

SaaS Tools Trap Knowledge

Tools like Notion or Confluence trap feedback in proprietary silos, separating doc reviews from your codebase.

AI Orchestrated

AI Agents Maintain Docs

Markdown files serve as indexable context for AI agents like Cursor, Claude, and Copilot to inspect, generate, and update docs in Git.

Human Orchestrated

Humans Review Rendered Pages

Stakeholders review rendered web views with inline comment threads, stored natively in Git custom refs without PR noise.

Unified Git Backend.
Complete Team Alignment.

Comments posted on rendered web docs write directly to Git custom refs. Developers and AI agents in Cursor, Antigravity, or VS Code see the feedback instantly anchored to markdown source lines and resolve it in place.

Developers & Agentic IDEs
Cursor, Antigravity, VS Code
Shared Git Backend
refs/md-comments/*
Business Users & Reviewers
Rendered Web Docs, Astro, HTML

Clean Source Branches.
Zero Overhead Custom Refs.

Isolated Namespace, Zero PR Overhead

Comments live in refs/md-comments/, keeping branches, commit logs, and CI pipelines clean without pull request friction.

Universal Client Interoperability

Web embeds, browser extensions, VS Code, Cursor, Antigravity, and Obsidian share the exact same data schema, with instant cross client sync.

Cryptographic Integrity

Anchored with commit SHAs and content hashing, comments preserve history across Git checkouts and attach accurately across file edits.

Integrations for Your Workflow

Every integration connects to the same Git backend. Comments left on web docs appear instantly in Cursor, Antigravity, and VS Code, and vice versa.

Browser Extensions for GitHub

Collaborate natively on GitHub markdown files and pull request diffs. Adds a dedicated comments panel directly into Markdown previews, powered by custom Git refs with zero PR friction.

  • Adds a dedicated comments panel to Markdown file previews & PR diffs.
  • Inline paragraph hover pins with highlighted commented text.
  • Auto-saves live via custom git refs with zero commits or branch overhead.
Required for all extensions:

Agentic IDEs & Editors

Native real-time collaboration inside AI-assisted and modern code editors. View, create, and resolve comments alongside code changes with full Cursor, Google Antigravity, and VS Code support.

  • Full compatibility with Cursor AI workflows, Google Antigravity IDE, VSCodium & VS Code.
  • Interactive side panel mapping comment threads to lines with selection anchoring.
  • Direct two-way sync with Git custom refs and web documentation.
  • Command Palette action to scan for orphaned comments across branches.

Websites & Documentation Portals

Add collaborative inline comments to any documentation website, static site, or plain HTML page. Readers and reviewers can highlight text and comment with zero browser extensions required.

HTML Embed Snippet (Any Website)
<!-- Drop Markdown Comments into any HTML document -->
<script
  src="https://unpkg.com/@md-comments/embed/dist/md-comments.min.js"
  data-repo="owner/repo"
  data-file="docs/architecture.md"
  async>
</script>
  • Works with any static site, Astro, Starlight, VitePress, Hugo, Docusaurus, or plain HTML.
  • Highlight prose to comment with floating selection bubble and interactive margin pins.
  • Built-in GitHub OAuth Device Flow with zero server infrastructure.
  • Shared Git ref sync compatible with GitHub Extension, VS Code, Cursor, Antigravity & Obsidian.

Desktop Apps & Obsidian

Bring native collaboration to your personal knowledge base. Right-click any block in Live Preview or Reading Mode to start inline comment discussions powered by GitHub.

  • Integrates seamlessly with Obsidian's right sidebar ribbon and note viewports.
  • Supports Obsidian Sync, Dropbox, and Git vault backup.
  • Custom Author fallback using Git username configs.
  • Universal Git ref sync compatible with Browser Extensions, IDEs, and Websites.