Skip to content

docs: better install instructions for lazy.nvim #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 22, 2024
Merged

docs: better install instructions for lazy.nvim #80

merged 3 commits into from
Jul 22, 2024

Conversation

chrisgrieser
Copy link
Contributor

@chrisgrieser chrisgrieser commented Jul 21, 2024

  • ft ensures the plugin is only loaded in markdown files
  • main defines the module name used in the setup call, we can use opts instead of config (cleaner & preferred method of configuring plugins in lazy.nvim)
  • consequently, we are able to replace config with opts. reference: https://lazy.folke.io/spec#spec-setup
  • also added the missing trailing comma for lazy plugin specs

- `ft` ensures the plugin is only loaded in markdown files
- `main` defines the module name used in the `setup` call, we can use `opts` instead of `config` (cleaner & preferred method of configuring plugins in lazy.nvim)
- consequently, we are able to replace `config` with `opts`.

reference: https://lazy.folke.io/spec#spec-setup
@MeanderingProgrammer
Copy link
Owner

I appreciate the PR, and agree with most of the changes, but not the filetype addition.

This plugin is not limited to a specific filetype, several users integrate markdown in many filetypes. I leave optimizing startup time to more advanced users that are aware of what these things do, I'm not going to suggest this approach as the default.

@chrisgrieser
Copy link
Contributor Author

chrisgrieser commented Jul 21, 2024

Fair enough, removed the ft

@MeanderingProgrammer
Copy link
Owner

Thank you!

@MeanderingProgrammer MeanderingProgrammer merged commit 13b7de5 into MeanderingProgrammer:main Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants