diff --git a/LICENSE b/LICENSE index de863a84..b0c97a89 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright 2020-2025 NixVim contributors +Copyright 2020-2025 Nixvim contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/lib/index.md b/docs/lib/index.md index f974029d..f44bedba 100644 --- a/docs/lib/index.md +++ b/docs/lib/index.md @@ -56,7 +56,7 @@ You can also import inside the submodule: # You can use lib.nixvim in your config fooOption = lib.nixvim.mkRaw "print('hello')"; - # Configure NixVim without prefixing with `plugins.nixvim` + # Configure Nixvim without prefixing with `plugins.nixvim` plugins.my-plugin.enable = true; } ``` diff --git a/docs/man/nixvim-header-end.5 b/docs/man/nixvim-header-end.5 index d8b26530..205c6e5f 100644 --- a/docs/man/nixvim-header-end.5 +++ b/docs/man/nixvim-header-end.5 @@ -1,3 +1,3 @@ .SH "OPTIONS" .PP -You can use the following options in a NixVim module. +You can use the following options in a Nixvim module. diff --git a/docs/man/nixvim-header-start.5 b/docs/man/nixvim-header-start.5 index 1000d0d6..4b3243fe 100644 --- a/docs/man/nixvim-header-start.5 +++ b/docs/man/nixvim-header-start.5 @@ -1,4 +1,4 @@ -.TH "NIXVIM" "5" "01/01/1980" "NixVim" "NixVim Reference Pages" +.TH "NIXVIM" "5" "01/01/1980" "Nixvim" "Nixvim Reference Pages" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -6,7 +6,7 @@ .\" enable line breaks after slashes .cflags 4 / .SH "NAME" -NixVim options specification +Nixvim options specification .SH "DESCRIPTION" .PP -This page lists all the options that can be used in NixVim. It can either be used as a Home Manager module, an NixOS module or a standalone package. Please refer to the installation instructions for more details. +This page lists all the options that can be used in Nixvim. It can either be used as a Home Manager module, an NixOS module or a standalone package. Please refer to the installation instructions for more details. diff --git a/docs/mdbook/SUMMARY.md b/docs/mdbook/SUMMARY.md index 0b1223c1..9165456b 100644 --- a/docs/mdbook/SUMMARY.md +++ b/docs/mdbook/SUMMARY.md @@ -1,4 +1,4 @@ -# Structure for nixvim docs +# Structure for Nixvim docs - [Home](./index.md) @@ -27,4 +27,4 @@ [Contributing](./CONTRIBUTING.md) [Maintaining](./MAINTAINING.md) -[NixVim Options Search](./search/index.html) +[Nixvim Options Search](./search/index.html) diff --git a/docs/mdbook/index.md b/docs/mdbook/index.md index b322bcfc..14fe5f34 100644 --- a/docs/mdbook/index.md +++ b/docs/mdbook/index.md @@ -1,4 +1,4 @@ -# NixVim - A Neovim configuration system for nix +# Nixvim - A Neovim configuration system for nix ## Other versions of these docs diff --git a/docs/platforms/standalone.md b/docs/platforms/standalone.md index 3721ca41..a7f627de 100644 --- a/docs/platforms/standalone.md +++ b/docs/platforms/standalone.md @@ -51,13 +51,13 @@ This will generate a `init.lua` that will contain the comments from each stages: ## Accessing options used in an existing configuration -The `config` used to produce a standalone nixvim derivation can be accessed as an attribute on the derivation, similar to `.extend`. +The `config` used to produce a standalone Nixvim derivation can be accessed as an attribute on the derivation, similar to `.extend`. -This may be useful if you want unrelated parts of your NixOS, Home Manager or nix-darwin configuration to use the same value as something in your nixvim configuration. +This may be useful if you want unrelated parts of your NixOS, Home Manager or nix-darwin configuration to use the same value as something in your Nixvim configuration. -## Accessing nixvim options +## Accessing Nixvim options -Given a nixvim derivation it is possible to access the module options using `.options`. +Given a Nixvim derivation it is possible to access the module options using `.options`. This can be useful to configure `nixd` for example: ```nix diff --git a/docs/user-guide/config-examples.md b/docs/user-guide/config-examples.md index 2a19d4b0..5c467de8 100644 --- a/docs/user-guide/config-examples.md +++ b/docs/user-guide/config-examples.md @@ -8,7 +8,7 @@ Take a look at these configuration examples below. **Note:**\ Most of those configurations are using a [standalone build](../platforms/standalone.html), however, -all of the nixvim options are accessible no matter how you are using it (flake, NixOS/HM module, nix-darwin...). +all of the Nixvim options are accessible no matter how you are using it (flake, NixOS/HM module, nix-darwin...). @USER_CONFIGS@ diff --git a/docs/user-guide/faq.md b/docs/user-guide/faq.md index 1a23446d..d2625876 100644 --- a/docs/user-guide/faq.md +++ b/docs/user-guide/faq.md @@ -7,7 +7,7 @@ Using a plugin not supported by nixvim, but packaged in nixpkgs is straightforwa - Register the plugin through `extraPlugins`: `extraPlugins = [pkgs.vimPlugins.""]`. - Configure the plugin through `extraConfigLua`: `extraConfigLua = "require('my-plugin').setup({foo = "bar"})";` -## How do I use a plugin not yet merged into NixVim or temporarily modify one +## How do I use a plugin not yet merged into Nixvim or temporarily modify one Copy the module expression formatted like this into a file: @@ -18,7 +18,7 @@ lib.nixvim.plugins.mkNeovimPlugin { } ``` -Import it into your NixVim configuration and configure it: +Import it into your Nixvim configuration and configure it: ```nix { # Remove this `programs.nixvim` wrapper for standalone configurations @@ -84,13 +84,13 @@ When using Nixvim, it is possible to encounter errors about something not being ``` This usually means one of two things: -- The nixpkgs version is not in line with NixVim (for example nixpkgs nixos-25.11 is used with NixVim master) -- The nixpkgs unstable version used with NixVim is not recent enough. +- The nixpkgs version is not in line with Nixvim (for example nixpkgs nixos-25.11 is used with Nixvim master) +- The nixpkgs unstable version used with Nixvim is not recent enough. -When building nixvim using flakes and our ["standalone mode"][standalone], we usually recommend _not_ declaring a "follows" for `inputs.nixvim`. -This is so that nixvim is built against the same nixpkgs revision we're using in our test suite. +When building Nixvim using flakes and our ["standalone mode"][standalone], we usually recommend _not_ declaring a "follows" for `inputs.nixvim`. +This is so that Nixvim is built against the same nixpkgs revision we're using in our test suite. -If you are building nixvim using the NixOS, Home Manager, or nix-darwin modules then we advise that you keep your nixpkgs lock as close as possible to ours. +If you are building Nixvim using the NixOS, Home Manager, or nix-darwin modules then we advise that you keep your nixpkgs lock as close as possible to ours. > [!TIP] > Once [#1784](https://github.com/nix-community/nixvim/issues/1784) is implemented, there will be alternative ways to achieve this using the module system. @@ -139,7 +139,7 @@ keymaps = [ [`map`]: https://nixos.org/manual/nix/stable/language/builtins#builtins-map [`keymaps`]: ../keymaps -## How to use system provided binaries instead of nixvim provided ones +## How to use system provided binaries instead of Nixvim provided ones There are a number of plugins that install extra packages using `nix`, but this can cause issues. For example enabling `plugins.treesitter` could add `gcc` to the PATH of neovim, and this could break workflows that rely on the system provided compiler. diff --git a/docs/user-guide/install.md b/docs/user-guide/install.md index 1e8dafbb..0ca29870 100644 --- a/docs/user-guide/install.md +++ b/docs/user-guide/install.md @@ -1,25 +1,25 @@ # Installation -You must use a `nixpkgs` version compatible with the nixvim version you choose. +You must use a `nixpkgs` version compatible with the Nixvim version you choose. The `main` branch requires to use a _very recent_ version of nixpkgs unstable. -In order to guarantee the compatibility between nixvim & nixpkgs it is recommended to always update both at the same time. +In order to guarantee the compatibility between Nixvim & nixpkgs it is recommended to always update both at the same time. -When using a `stable` version you must use the corresponding nixvim branch, for example `nixos-25.11` when using NixOS 25.11. +When using a `stable` version you must use the corresponding Nixvim branch, for example `nixos-25.11` when using NixOS 25.11. Failure to use the correct branch, or an old revision of nixpkgs will likely result in errors of the form `vimPlugins. attribute not found`. -NixVim can be used in four ways: +Nixvim can be used in four ways: - As a NixOS module - As a Home Manager module - As a nix-darwin module - As a standalone derivation -NixVim is also available for nix flakes, or directly through an import. +Nixvim is also available for nix flakes, or directly through an import. ## Accessing nixvim -For a direct import you can add nixvim to your configuration as follows: +For a direct import you can add Nixvim to your configuration as follows: ```nix let nixvim = import (builtins.fetchGit { @@ -45,30 +45,30 @@ When using flakes you can simply add `nixvim` to the inputs: ## Usage -NixVim can be used standalone or as a module for NixOS, Home Manager, or nix-darwin. +Nixvim can be used standalone or as a module for NixOS, Home Manager, or nix-darwin. -When used standalone, a custom NixVim derivation is produced that can be used like any other package. +When used standalone, a custom Nixvim derivation is produced that can be used like any other package. -When used as a module, NixVim can be enabled though `programs.nixvim.enable`. +When used as a module, Nixvim can be enabled though `programs.nixvim.enable`. ### Usage as a module (NixOS, Home Manager, nix-darwin) -When using NixVim as a module you must import the NixVim module into your module system. +When using Nixvim as a module you must import the Nixvim module into your module system. The three imports are: - `.homeModules.nixvim` - `.nixosModules.nixvim` - `.nixDarwinModules.nixvim` -`` refers to the way to access nixvim, depending on how you fetched nixvim as described in the previous section. +`` refers to the way to access Nixvim, depending on how you fetched Nixvim as described in the previous section. The imports can be added as a `imports = [ ]` in a configuration file. -You will then be able to enable nixvim through `programs.nixvim.enable = true`, and configure the +You will then be able to enable Nixvim through `programs.nixvim.enable = true`, and configure the options as `programs.nixvim...