Skip to content

Commit

Permalink
chore: NvChad instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmh committed Oct 29, 2024
1 parent 61b93f6 commit ae83959
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Highlight support for mdx based in [the post] written by [Phelipe Teles].

## Installation

With [lazy.nvim]:
#### With [lazy.nvim]

```lua
{
Expand All @@ -16,7 +16,20 @@ With [lazy.nvim]:
}
```

#### 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

0 comments on commit ae83959

Please sign in to comment.