nix-community.nixvim/docs/mdbook/index.md

# NixVim - A Neovim configuration system for nix

## Other versions of these docs

Please ensure you are referencing documentation that corresponds to the Nixvim version you are using!

Documentation is currently available for the following versions:

@DOCS_VERSIONS@

## Recent Breaking Changes

> [!CAUTION]
> By default, Nixvim now constructs its own instance of nixpkgs, using the revision from our flake.lock.
> This change was largely motivated by: [How do I solve "`<name>` cannot be found in `pkgs`"](./user-guide/faq.html#how-do-i-solve-name-cannot-be-found-in-pkgs)
>
> The old behaviour can be restored by enabling `nixpkgs.useGlobalPackages`.
>
> If your flake modifies the `nixpkgs` through `follows` this can still cause issues by changing the expected `nixpkg` `nixvim` was tested & built against.

@README@

## Welcome to the docs!

Over to the left, you'll find the sidebar. There you'll see several "User guides" (including an [FAQ](./user-guide/faq.md)), along with pages for various "options".

While you can search our main docs using the <i class="fa fa-search"></i> icon, if you're looking for a specific option you may find the dedicated [Nixvim Option Search](./search/index.html) (at the bottom of the sidebar) has more relevant results.

> [!TIP]
> Any page with a ❱ icon next to it has one-or-more _sub-pages_.
docs: introduce a dedicated homepage Based of the README for now, with a small additional "welcome to the docs" section. Perhaps in future, we could re-use the README.md verbatim? Perhaps with some additional post-processing. I think we'd want to dramatically reduce its size first though. By having a dedicated homepage outside of `user-guide`, this fixes #1625 2024-10-21 18:02:37 +01:00			`# NixVim - A Neovim configuration system for nix`

docs: link to all "available" versions of the docs 2024-11-20 19:47:27 +00:00			`## Other versions of these docs`

			`Please ensure you are referencing documentation that corresponds to the Nixvim version you are using!`

			`Documentation is currently available for the following versions:`

			`@DOCS_VERSIONS@`

docs: notify `useGlobalPackages` breaking change 2025-01-19 13:23:14 +00:00			`## Recent Breaking Changes`

			`> [!CAUTION]`
			`> By default, Nixvim now constructs its own instance of nixpkgs, using the revision from our flake.lock.`
			> This change was largely motivated by: [How do I solve "`<name>` cannot be found in `pkgs`"](./user-guide/faq.html#how-do-i-solve-name-cannot-be-found-in-pkgs)
			`>`
			> The old behaviour can be restored by enabling `nixpkgs.useGlobalPackages`.
docs: add note on "following" nixpkgs input (#3317) The use of `follows` in a flake can cause issues even when `useGlobalPackages` is disabled. Highlight this in the doc. 2025-05-12 13:58:54 -07:00			`>`
			> If your flake modifies the `nixpkgs` through `follows` this can still cause issues by changing the expected `nixpkg` `nixvim` was tested & built against.
docs: notify `useGlobalPackages` breaking change 2025-01-19 13:23:14 +00:00
docs: use README as a source for the docs 2025-01-19 13:56:54 +00:00			`@README@`
docs: introduce a dedicated homepage Based of the README for now, with a small additional "welcome to the docs" section. Perhaps in future, we could re-use the README.md verbatim? Perhaps with some additional post-processing. I think we'd want to dramatically reduce its size first though. By having a dedicated homepage outside of `user-guide`, this fixes #1625 2024-10-21 18:02:37 +01:00
			`## Welcome to the docs!`

docs: fix typo 2025-04-22 08:32:56 +10:00			`Over to the left, you'll find the sidebar. There you'll see several "User guides" (including an [FAQ](./user-guide/faq.md)), along with pages for various "options".`
docs: introduce a dedicated homepage Based of the README for now, with a small additional "welcome to the docs" section. Perhaps in future, we could re-use the README.md verbatim? Perhaps with some additional post-processing. I think we'd want to dramatically reduce its size first though. By having a dedicated homepage outside of `user-guide`, this fixes #1625 2024-10-21 18:02:37 +01:00
			`While you can search our main docs using the <i class="fa fa-search"></i> icon, if you're looking for a specific option you may find the dedicated [Nixvim Option Search](./search/index.html) (at the bottom of the sidebar) has more relevant results.`

			`> [!TIP]`
			`> Any page with a ❱ icon next to it has one-or-more _sub-pages_.`