mdmath.nvim
A Neovim plugin that previews inline LaTeX equations in Markdown files using the Kitty Graphics Protocol.
What is mdmath.nvim?
mdmath.nvim is a Neovim plugin that provides real-time previews of LaTeX equations embedded in Markdown files. It renders equations as inline images directly in the terminal using the Kitty Graphics Protocol, eliminating the need to switch to external preview tools while writing technical or academic documents.
Neovim users who write Markdown documents containing mathematical notation, such as researchers, students, and technical writers.
It offers a seamless, terminal-integrated equation preview experience without leaving Neovim, with dynamic sizing and configurable display options tailored for Markdown workflows.
Overview
A Neovim plugin for inline LaTeX equation previews in Markdown.
Use Cases
Best For
- Writing academic papers with LaTeX equations in Markdown
- Creating technical documentation that includes mathematical formulas
- Previewing LaTeX math inline while editing in Neovim
- Avoiding external GUI tools for equation rendering
- Using Kitty terminal with Neovim for enhanced Markdown editing
- Dynamic scaling of equation images based on content
Not Ideal For
- Users on terminals without Unicode Placeholders support, like Konsole or WezTerm
- Developers on Windows or untested platforms due to Linux/MacOS focus
- Teams needing stable, production-ready plugins without alpha-stage limitations
- Projects requiring advanced features like floating window previews, not yet implemented
Pros & Cons
Pros
Renders LaTeX equations as images directly in the Neovim buffer using Kitty Graphics Protocol, eliminating the need for external preview tools as highlighted in the key features.
Automatically adjusts equation dimensions for non-inline equations with configurable scales via the dynamic_scale option, ensuring better visual integration in documents.
Hides equations under the cursor or during insertion via anticonceal and hide_on_insert options, reducing clutter while editing for enhanced clarity.
Prioritizes a terminal-native approach within Neovim, avoiding GUI tools and keeping the workflow seamless as per the plugin's philosophy.
Cons
Only fully supports Kitty terminal (>=0.28.0); other terminals lack Unicode Placeholders support, restricting usability across different setups as admitted in the README.
Missing key features like floating windows and out-of-line rendering, with many planned items still in development, making it incomplete for advanced use cases.
Requires NodeJS, npm, ImageMagick, and rsvg-convert, plus specific terminal configurations, creating a steep installation barrier compared to simpler plugins.
Frequently Asked Questions
Related Projects
markdown-preview.nvimmarkdown preview plugin for (neo)vim
render-markdown.nvimImprove viewing Markdown in Neovim
markview.nvimA hackable markdown, Typst, latex, html(inline) & Asciidoc previewer for Neovim
peek.nvimMarkdown preview plugin for Neovim
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.