From 7afeb7913b6891b452499ff43da06a22ae66ba3f Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Wed, 2 Aug 2023 10:42:52 +0000 Subject: [PATCH] deploy: 98b92c64db62c36aebdad61764d397781cb2ef3a --- index.html | 9 ++++++--- options.html | 2 ++ 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/index.html b/index.html index d515470..fe7fa9f 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -neovim-flake Manual
neovim-flake Manual
   Next

neovim-flake Manual

Preface
1. Try it out
1.1. Nix
1.2. Tidal
1.3. Maximal
1.4. Using Prebuilt Configs
2. Default Configs
2.1. Tidal Cycles
2.2. Nix
2.3. Maximal
3. Custom Configuration
4. Custom Plugins
4.1. New Method
4.2. Old Method
5. Home Manager
6. Language Support
A. Configuration Options
B. Release Notes
B.1. Release 0.1
B.1.1. Changelog
B.2. Release 0.2
B.2.1. Changelog
B.3. Release 0.3
B.3.1. Changelog
B.4. Release 0.4
B.4.1. Changelog

Preface

+neovim-flake Manual

neovim-flake Manual
   Next

neovim-flake Manual

Preface
1. Try it out
1.1. Nix
1.2. Tidal
1.3. Maximal
1.4. Using Prebuilt Configs
2. Default Configs
2.1. Tidal Cycles
2.2. Nix
2.3. Maximal
3. Custom Configuration
4. Custom Plugins
4.1. New Method
4.2. Old Method
5. Custom Neovim Package
6. Home Manager
7. Language Support
A. Configuration Options
B. Release Notes
B.1. Release 0.1
B.1.1. Changelog
B.2. Release 0.2
B.2.1. Changelog
B.3. Release 0.3
B.3.1. Changelog
B.4. Release 0.4
B.4.1. Changelog

Preface

If your problem is caused by a bug in neovim-flake then it should be reported on the neovim-flake issue tracker. Alongside bug reports, feature requests are also welcome over @@ -70,7 +70,10 @@ To add a plugin, you need to add it to your config’s con }

However, just making the plugin available might not be enough. In that case, you can write custom vimscript or lua config, using config.vim.configRC or config.vim.luaConfigRC respectively. These options are attribute sets, and you need to give the configuration you’re adding some name, like this:

{
   config.vim.configRC.aquarium = "colorscheme aquiarum";
-}

Note: If your configuration needs to be put in a specific place in the config, you can use functions from inputs.neovim-flake.lib.nvim.dag to order it. Refer to https://github.com/nix-community/home-manager/blob/master/modules/lib/dag.nix.

Also, if you successfully made your plugin work, please make a PR to add it to the flake, or open an issue with your findings so that we can make it available for everyone easily.

Chapter 5. Home Manager

The Home Manager module allows us to customize the different vim options. To use it, we first add the input flake.

{
+}

Note: If your configuration needs to be put in a specific place in the config, you can use functions from inputs.neovim-flake.lib.nvim.dag to order it. Refer to https://github.com/nix-community/home-manager/blob/master/modules/lib/dag.nix.

Also, if you successfully made your plugin work, please make a PR to add it to the flake, or open an issue with your findings so that we can make it available for everyone easily.

Chapter 5. Custom Neovim Package

As of v0.5, you may now specify the neovim package that will be wrapped with your configuration. This is done with the vim.package option.

{inputs, pkgs, ...}: {
+  # using the neovim-nightly overlay
+  config.vim.package = inputs.neovim-overlay.packages.${pkgs.system}.neovim;
+}

The neovim-nightly-overlay always exposes an unwrapped package. If using a different source, you are highly recommended to get an "unwrapped" version of the neovim package,similar to neovim-unwrapped in nixpkgs.

Chapter 6. Home Manager

The Home Manager module allows us to customize the different vim options. To use it, we first add the input flake.

{
   neovim-flake = {
     url = github:notashelf/neovim-flake;
     # you can override input nixpkgs
@@ -91,7 +94,7 @@ These options are attribute sets, and you need to give the configuration you’r
       };
     };
   };
-}

Chapter 6. Language Support

Language specific support means there is a combination of language specific plugins, treesitter support, nvim-lspconfig language servers, and null-ls integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the vim.languages attribute. See the configuration docs for details.

  • +}

Chapter 7. Language Support

Language specific support means there is a combination of language specific plugins, treesitter support, nvim-lspconfig language servers, and null-ls integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the vim.languages attribute. See the configuration docs for details.

vim.enableLuaLoader

Whether to enable experimental Lua module loader to speed up the start up process.

Type: boolean

Default: false

Example: true

Declared by:

<neovim-flake/modules/basic/module.nix> +
vim.package

The neovim package to use. You will need to use an unwrapped package for this option to work as intended.

Type: package

Default: <derivation neovim-unwrapped-0.9.1>

Declared by:

+ <neovim-flake/modules/basic/module.nix>
vim.assistant.copilot.enable

Whether to enable GitHub Copilot AI assistant.

Type: boolean

Default: false

Example: true

Declared by:

<neovim-flake/modules/assistant/copilot/copilot.nix>
vim.assistant.copilot.cmp.enable

Whether to enable nvim-cmp integration for GitHub Copilot.

Type: boolean

Default: false

Example: true

Declared by: