Skip to content

phine-apps/rich-markdown-diff

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

110 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rich Markdown Diff

A professional VS Code extension for visual Markdown comparison. Compare rendered HTML side-by-side or inline, including Math, Mermaid, and complex slide decks.

Split View

Key Features

  • Visual Diff: Compare rendered HTML side-by-side or inline instead of raw source code.
  • Git Integration: Compare changes directly from the VS Code Source Control view (Workspace, Staged, or HEAD).
  • Git Blame: Hover over any line in the diff view to instantly see its commit author and history.
  • Interactive Image Diff: Compare visual changes in images using "Swipe" and "Onion Skin" comparison modes.
  • Quick Edit: Modify image paths and frontmatter metadata directly within the preview panels.
  • Clipboard Compare: Instantly compare any active Markdown file against your clipboard contents.

Supported Extensions

Extension Support Details
MDX / Custom Native diffing for MDX, Docusaurus, and Astro Starlight components (Tabs, Steps, Badges, Cards, and Admonitions).
Marp Render and diff slide decks with full theme support.
Math High-quality KaTeX rendering for formulas.
Mermaid Flowcharts, sequence diagrams, and Gantt charts with VS Code theme-aware rendering.
Obsidian Native support for Tags (#tag) and Transclusions (![[link]]).
Alerts GitHub-style [!NOTE], [!WARNING], etc.
Structure Robust diffing for Tables, Nested Lists, Footnotes, and block-level math/code changes.
Misc Wikilinks, Emoji, Sub/Superscript, and Definition Lists.

Use Cases

  • 🖼️ Marp Presentations: Verify slide layout and theme changes visually.
  • 📚 Knowledge Bases: Review changes in foam/wiki notes with wikilinks and footnotes.
  • 🌐 Modern Tech Docs: Catch rendering issues in MDX, Docusaurus, and Astro Starlight components.
  • 📖 Technical Docs: Catch rendering issues in Mermaid diagrams, math formulas, and wide comparison tables.
  • 🔬 Academic Writing: Track revisions to LaTeX equations and complex tables.
  • 👥 Peer Review: Focus on the final rendered output rather than raw Markdown syntax.

Usage

1. Compare Files

Select two .md files in the Explorer, right-click, and select Show Markdown Diff.

2. Git & SCM

Click the Show Markdown Diff icon next to any modified Markdown file in the Source Control view.

SCM Diff

3. Clipboard Comparison

Right-click in any Markdown editor and choose Compare with Clipboard.

Technical Details

For technical setup or contribution guidelines, please see:

Recommended Extensions

If you enjoy Rich Markdown Diff, you might also like:

  • 🔗 Markdown Link Assistant: The ultimate link manager for Visual Studio Code. Effortlessly transform raw URLs into beautiful, structured link previews and Notion-like cards with instant previews and AI summaries.

License

Licensed under the MIT License.

About

VS Code extension for visually comparing Markdown files with rendered HTML diffs — supports KaTeX, Mermaid, GitHub Alerts, footnotes, and more.

Topics

Resources

License

Contributing

Stars

6 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors