Skip to content

Dujma/markdown-comment

Repository files navigation

Markdown Comments

A browser-based tool for adding inline review comments to Markdown files using CriticMarkup syntax. Designed as a feedback layer for AI-assisted writing workflows — annotate a document, then generate a prompt that instructs an AI to implement your feedback.

Quick Start

git clone <repo-url>
cd markdown-comments
npm install
npm run dev

Open http://localhost:5173 in your browser.

Usage

  1. Open a .md file (or edit the built-in sample)
  2. Switch to Preview mode
  3. Select text to attach a comment — a bubble appears for your note
  4. Hover over highlighted text to see the comment tooltip
  5. Use the sidebar to browse all comments and click to navigate
  6. Click Copy Prompt to copy an AI-ready prompt to your clipboard
  7. Paste the prompt into your AI tool of choice to apply the feedback

Scripts

Command Description
npm run dev Start dev server with hot reload
npm run build Type-check and production build
npm run preview Serve the production build locally
npm run lint Run ESLint

How It Works

Comments are stored as inline CriticMarkup in the Markdown source:

This is {==highlighted text==}{>>your comment here<<} in the document.

The Copy Prompt button copies a prompt to your clipboard like:

I have reviewed the document and added comments using CriticMarkup syntax
({==highlighted text==}{>>comment<<}).
Please review the comments, ask if anything is unclear, or implement them
straightaway if everything is clear.

You can paste this directly into Claude, ChatGPT, or any LLM to get an updated document.

Tech Stack

  • React 19 + TypeScript
  • Vite
  • CodeMirror (code editing)
  • react-markdown + remark-gfm + rehype-raw (preview rendering)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors