Skip to content

FrankLedo/markdown-pr-review

Repository files navigation

Markdown PR Review

Read and review GitHub Pull Request comments on rendered markdown — right inside VS Code.

The problem

In AI-first development, more decisions live in Markdown — design docs, RFCs, architecture decision records. We generate them faster than ever. Then we review them as GitHub PRs and stare at raw syntax.

Reviewing long-form markdown through a GitHub PR is painful. The diff view shows raw syntax. The rendered preview and the review comments live in separate places. You end up bouncing between tabs, losing context with every switch.

How it works

The interesting engineering problem: GitHub comments carry a source line number, but rendered HTML has no concept of source lines. The fix is source maps — markdown-it has a mode that emits data-line attributes on every rendered element. Match the comment's line number to the nearest data-line node in the DOM, and you have a precise anchor.

Opens a rendered preview of your markdown file with GitHub PR comment threads overlaid inline — anchored to the exact rendered element they were left on. No raw syntax. No tab switching.

Markdown PR Review in action

Features

  • Inline comment threads anchored to the rendered line via source maps
  • Comment on any line — select any text, even outside the diff; the comment anchors to the nearest changed line and the original line is noted in the comment body
  • Full thread lifecycle — reply, edit, delete, resolve, unresolve
  • Draft review batching — accumulate comments and submit as one review
  • File switcher — jump between all markdown files in the PR from the header dropdown
  • Navigation strip — ↑↓ buttons and [ / ] keyboard shortcuts to move between threads; Expand All / Close All controls
  • Mermaid diagram support — comments anchor to the fence block; diagrams render in VS Code's light or dark theme
  • YAML front matter rendered as a styled key-value block
  • GitHub authentication via VS Code's built-in auth — no setup required

Usage

  1. Switch to a PR branch in a repository with an open GitHub PR
  2. Click the PR #N item in the status bar (bottom right), or run Open PR Review from the Command Palette (Ctrl+Shift+P / Cmd+Shift+P), or right-click any markdown file → Open PR Review
  3. Browse the rendered preview with comment threads overlaid inline

Authentication

Uses VS Code's built-in GitHub authentication — you'll be prompted to sign in on first use. No configuration needed.

Requirements

VS Code 1.85 or later.

Install

Install from the VS Code Marketplace, search Markdown PR Review in the Extensions view, or install from the command line:

code --install-extension frankledo.markdown-pr-review

License

MIT

About

VS Code extension to read and review GitHub PR comments on rendered markdown — inline threads, Mermaid diagrams, full thread lifecycle

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors