docs(readme): add nixvim example

[HeitorAugustoLN]

Also improved consistency of the examples formatting

[github-actions]

Review Checklist

Does this PR follow the Contribution Guidelines? Following is a partial checklist:

Proper conventional commit scoping:

• For example, fix(context): some bugfix

• Pull request title has the appropriate conventional commit prefix.

If applicable:

• Tested
  • Tests have been added.
  • Tested manually (Steps to reproduce in PR description).
• Updated documentation.

[mrcjkb]

Hey 👋

thanks for the PR. As the NixVim interface could change, it would be best to just link to the NixVim docs.

[HeitorAugustoLN]

As the NixVim interface could change, it would be best to just link to the NixVim docs.

About that, I don't think it really will change since I think it is in a good state right now, lazyLoad.settings is just a freeform settings of the lazy-loading provider, which is probably the best solution. Also if it changes I can update it. But I don't see any problems in linking it to the nixvim docs, if you really want to.

[mrcjkb]

Sure, we can add the examples, but we should definitely link to the NixVim docs with a note like

Note

You can find up-to-date NixVim documentation for lazy-loading with lz.n here.

[mrcjkb]

The CI failure is probably markdownlint.

[HeitorAugustoLN]

Sure, we can add the examples, but we should definitely link to the NixVim docs with a note like

Note

You can find up-to-date NixVim documentation for lazy-loading with lz.n here.

Got it.

[mrcjkb]

thanks 🙏

one more thing I just realised. The NixVim nixos/home-manager examples look almost identical.
I'd suggest just a single NixVim example. Home-manager users will likely know how to enable NixVim.

[HeitorAugustoLN]

one more thing I just realised. The NixVim nixos/home-manager examples look almost identical.
I'd suggest just a single NixVim example. Home-manager users will likely know how to enable NixVim.

Done