mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

readme: correct grammar and spelling mistakes

Browse source
This commit is contained in:
Mikael Fangel 2023-11-23 22:10:33 +00:00 • committed by Gaétan Lepage
parent ab9b6abc22
commit 5d3ea0430b
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -124,13 +124,13 @@ If you want to use it standalone, you can use the `makeNixvim` function:
} }
``` ```
To get started with a standalone configuration you can use the template by running the following command in an empty directory (recommended): To get started with a standalone configuration, you can use the template by running the following command in an empty directory (recommended):
``` ```
nix flake init --template github:nix-community/nixvim nix flake init --template github:nix-community/nixvim
``` ```
Alternatively if you want a minimal flake to allow building a custom neovim you Alternatively, if you want a minimal flake to allow building a custom neovim you
can use the following: can use the following:
<details> <details>
@ -171,7 +171,7 @@ config changes easily.
### With a `devShell` ### With a `devShell`
You can also use nixvim to define an instance which will only be available inside of a Nix `devShell`: You can also use nixvim to define an instance which will only be available inside a Nix `devShell`:
<details> <details>
<summary>devShell configuration</summary> <summary>devShell configuration</summary>
@ -190,20 +190,20 @@ in pkgs.mkShell {
### Advanced Usage ### Advanced Usage
You may want more control over the nixvim modules like: You may want more control over the nixvim modules, like:
- Splitting your configuration in multiple files - Splitting your configuration in multiple files
- Adding custom nix modules to enhance nixvim - Adding custom nix modules to enhance nixvim
- Change the nixpkgs used by nixvim - Change the nixpkgs used by nixvim
In this case you can use the `makeNixvimWithModule` function. In this case, you can use the `makeNixvimWithModule` function.
It takes a set with the following keys: It takes a set with the following keys:
- `pkgs`: The nixpkgs to use (defaults to the nixpkgs pointed at by the nixvim flake) - `pkgs`: The nixpkgs to use (defaults to the nixpkgs pointed at by the nixvim flake)
- `module`: The nix module definition used to extend nixvim. - `module`: The nix module definition used to extend nixvim.
This is useful to pass additional module machinery like `options` or `imports`. This is useful to pass additional module machinery like `options` or `imports`.
- `extraSpecialArgs`: Extra arguments to pass to the modules when using functions. - `extraSpecialArgs`: Extra arguments to pass to the modules when using functions.
Can be `self` in a flake for example. Can be `self` in a flake, for example.
## How does it work? ## How does it work?
When you build the module (probably using home-manager), it will install all When you build the module (probably using home-manager), it will install all
@ -219,7 +219,7 @@ Documentation is available on this project's GitHub Pages page:
[https://nix-community.github.io/nixvim](https://nix-community.github.io/nixvim) [https://nix-community.github.io/nixvim](https://nix-community.github.io/nixvim)
If the option `enableMan` is set to `true` (by default it is), man pages will also If the option `enableMan` is set to `true` (by default it is), man pages will also
be installed containing the same informations, they can be viewed with `man nixvim`. be installed containing the same information, they can be viewed with `man nixvim`.
## Plugins ## Plugins
After you have installed NixVim, you will no doubt want to enable some plugins. After you have installed NixVim, you will no doubt want to enable some plugins.
@ -235,7 +235,7 @@ So, to enable some supported plugin, all you have to do is enable its module:
} }
``` ```
Of course, if that was everything there wouldn't be much point to NixVim, you'd Of course, if that was everything, there wouldn't be much point to NixVim, you'd
just use a regular plugin manager. All options for supported plugins are exposed just use a regular plugin manager. All options for supported plugins are exposed
as options of that module. For now, there is no documentation yet, but there are as options of that module. For now, there is no documentation yet, but there are
detailed explanations in the source code. Detailed documentation for every detailed explanations in the source code. Detailed documentation for every
@ -285,7 +285,7 @@ If your colorscheme isn't provided as a module, install it using
``` ```
All NixVim supported plugins will, by default, use the main colorscheme you All NixVim supported plugins will, by default, use the main colorscheme you
set, though this can be overriden in a per-plugin basis. set, though this can be overridden on a per-plugin basis.
## Options ## Options
NeoVim has a lot of configuration options. You can find a list of them by doing NeoVim has a lot of configuration options. You can find a list of them by doing
@ -312,7 +312,7 @@ Please note that to, for example, disable numbers you would not set
### Caveats ### Caveats
If you are using `makeNixvimWithModule`, then options is treated as options for a module. To get around this just wrap the options in a `config` set. If you are using `makeNixvimWithModule`, then options are treated as options for a module. To get around this, just wrap the options in a `config` set.
```nix ```nix
{ {
@ -355,7 +355,7 @@ nnoremap <leader>m <silent> <cmd>make<CR>
``` ```
This table describes all modes for the `keymaps` option. This table describes all modes for the `keymaps` option.
You can provide several mode to a single mapping by using a list of strings. You can provide several modes to a single mapping by using a list of strings.
| Short | Description | | Short | Description |
|-------|--------------------------------------------------| |-------|--------------------------------------------------|