https://github.com/thiago4532/mdmath.nvim

A Neovim plugin for inline LaTeX equation previews in Markdown.
https://github.com/thiago4532/mdmath.nvim

lua markdown markdown-previewer neovim

Last synced: 5 days ago
JSON representation

A Neovim plugin for inline LaTeX equation previews in Markdown.

• Host: GitHub
• URL: https://github.com/thiago4532/mdmath.nvim
• Owner: Thiago4532
• License: mit
• Created: 2024-09-26T15:24:54.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-27T13:30:27.000Z (12 days ago)
• Last Synced: 2025-01-03T08:10:14.557Z (5 days ago)
• Topics: lua, markdown, markdown-previewer, neovim
• Language: Lua
• Homepage:
• Size: 73.2 KB
• Stars: 92
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ✨ mdmath.nvim

A Markdown equation previewer inside Neovim, using Kitty Graphics Protocol.

https://github.com/user-attachments/assets/bcfab0d2-60fb-4e8a-9402-2be62a5504f6

## Requirements

  - Neovim version `>=0.10.0`

  - Tree-sitter parser `markdown_inline`

### System requirements

  - NodeJS

  - `npm`

  - ImageMagick v6/v7

  - `rsvg-convert` (from librsvg)

  - Linux/MacOS (not tested in MacOS, please open an issue if you are able to test it)

You also need a terminal emulator that supports [Kitty Graphics Protocol#Unicode Placeholders](https://sw.kovidgoyal.net/kitty/graphics-protocol/#unicode-placeholders), the following terminals were tested.

  - [x] Kitty `>=0.28.0`

  - [ ] Konsole (missing support for Unicode Placeholders)

  - [ ] WezTerm (missing support for Unicode Placeholders)

After some refactoring, I want to implement a fallback for terminals that support Kitty Graphics Protocol but doesn't support Unicode Placeholders.

### Installation

>[!NOTE]

> If you have manually installed the parser then you don't need `nvim-treesitter`. Just make sure the parsers are loaded before this plugin.

### lazy.nvim

```lua

{

    'Thiago4532/mdmath.nvim',

    dependencies = {

        'nvim-treesitter/nvim-treesitter',

    },

    opts = {...}

    -- The build is already done by default in lazy.nvim, so you don't need

    -- the next line, but you can use the command `:MdMath build` to rebuild

    -- if the build fails for some reason.

    -- build = ':MdMath build'

},

```

### Other plugin managers

Just make sure to have the treesitter parser `markdown-inline` loaded before the plugin, also you have to build the plugin before using it, you can build it by running `:MdMath build` or `require'mdmath'.build()`.

## Configuration

Here is the table of configurations, and the default values:

```lua

opts = {

    -- Filetypes that the plugin will be enabled by default.

    filetypes = {'markdown'},

    -- Color of the equation, can be a highlight group or a hex color.

    -- Examples: 'Normal', '#ff0000'

    foreground = 'Normal',

    -- Hide the text when the equation is under the cursor.

    anticonceal = true,

    -- Hide the text when in the Insert Mode.

    hide_on_insert = true,

    -- Enable dynamic size for non-inline equations.

    dynamic = true,

    -- Configure the scale of dynamic-rendered equations.

    dynamic_scale = 1.0,

    -- Interval between updates (milliseconds).

    update_interval = 400,

    -- Internal scale of the equation images, increase to prevent blurry images when increasing terminal

    -- font, high values may produce aliased images.

    -- WARNING: This do not affect how the images are displayed, only how many pixels are used to render them.

    --          See `dynamic_scale` to modify the displayed size.

    internal_scale = 1.0,

}

```

## Usage

Currently, it only supports rendering the image inline, features like rendering at a floating window will be available soon.

  - `:MdMath enable`: Enable the plugin for the current buffer

  - `:MdMath disable`: Disable the plugin for the current buffer

  - `:MdMath clear`: Refresh all equations

  - `:MdMath build`: Build the node.js server

If you are using TMUX, remember to enable `allow-passthrough` in your `~/.tmux.conf`.

## Looking to the future!

The plugin is currently at alpha, many features are planned for the next versions, here are some of the planned features, also you have any suggestions, feel free to open an issue:

  - [ ] Support Kitty Graphics Protocol without Unicode Placeholders.

  - [ ] An API to generate equation images.

  - [ ] Render in floating windows

  - [ ] Render out-of-line

  - [x] Dynamic width and height

  - [ ] Refactoring: LuaCATS annotations

  - [ ] Documentation

  - [ ] `:checkhealth`