https://github.com/davidmh/mdx.nvim

Good enough syntax highlight for MDX in Neovim using Treesitter
https://github.com/davidmh/mdx.nvim

mdx neovim syntax-highlighting tree-sitter

Last synced: about 3 hours ago
JSON representation

Good enough syntax highlight for MDX in Neovim using Treesitter

• Host: GitHub
• URL: https://github.com/davidmh/mdx.nvim
• Owner: davidmh
• Created: 2024-02-05T05:26:35.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T02:17:12.000Z (22 days ago)
• Last Synced: 2024-10-29T03:21:19.642Z (22 days ago)
• Topics: mdx, neovim, syntax-highlighting, tree-sitter
• Language: Scheme
• Homepage:
• Size: 868 KB
• Stars: 28
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mdx.nvim

Good enough syntax highlight for MDX in Neovim using Treesitter.

Highlight support for mdx based in [the post] written by [Phelipe Teles].

## Installation

#### With [lazy.nvim]

```lua

{

  "davidmh/mdx.nvim",

  config = true,

  dependencies = {"nvim-treesitter/nvim-treesitter"}

}

```

#### With [NvChad]

From the NvChad [docs]:

> All NvChad default plugins will have `lazy = true` set. Therefore, if you want

> a plugin to be enabled on startup, change it to `lazy = false`.

Since this plugin only defines a filetype it's safe to let it run on startup.

So setting `lazy = false` is enough.

But if you absolutely need to loaded only when needed, you can use `event = "BufEnter *.mdx"`

[the post]: https://phelipetls.github.io/posts/mdx-syntax-highlight-treesitter-nvim/

[Phelipe Teles]: https://github.com/phelipetls

[lazy.nvim]: https://github.com/folke/lazy.nvim

[NvChad]: https://github.com/NvChad/NvChad

[docs]: https://nvchad.com/docs/config/plugins