deploy: 3c07796010

options.html

@@ -49,9 +49,13 @@ For NixOS, the default value for this option includes at least this argument:
                     <neovim-flake/modules/basic/module.nix>
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.assistant.copilot.enable"></a><a class="term" href="options.html#opt-vim.assistant.copilot.enable"><code class="option">vim.assistant.copilot.enable</code></a></span></dt><dd><p>Whether to enable GitHub Copilot AI assistant.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/assistant/copilot/copilot.nix#blob-path" target="_top">
                     &lt;neovim-flake/modules/assistant/copilot/copilot.nix&gt;
-                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.assistant.copilot.copilotNodePackage"></a><a class="term" href="options.html#opt-vim.assistant.copilot.copilotNodePackage"><code class="option">vim.assistant.copilot.copilotNodePackage</code></a></span></dt><dd><p>The package that will be used for Copilot. NodeJS v18 is recommended.</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">&lt;derivation nodejs-slim-18.16.1&gt;</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/assistant/copilot/copilot.nix#blob-path" target="_top">
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.assistant.copilot.cmp.enable"></a><a class="term" href="options.html#opt-vim.assistant.copilot.cmp.enable"><code class="option">vim.assistant.copilot.cmp.enable</code></a></span></dt><dd><p>Whether to enable nvim-cmp integration for GitHub Copilot.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/assistant/copilot/copilot.nix#blob-path" target="_top">
                     &lt;neovim-flake/modules/assistant/copilot/copilot.nix&gt;
-                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.assistant.copilot.copilot_node_command"></a><a class="term" href="options.html#opt-vim.assistant.copilot.copilot_node_command"><code class="option">vim.assistant.copilot.copilot_node_command</code></a></span></dt><dd><p>Path to nodejs</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${pkgs.nodejs-slim.out}/bin/node"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/assistant/copilot/copilot.nix#blob-path" target="_top">
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.assistant.copilot.copilotNodeCommand"></a><a class="term" href="options.html#opt-vim.assistant.copilot.copilotNodeCommand"><code class="option">vim.assistant.copilot.copilotNodeCommand</code></a></span></dt><dd><p>The command that will be executed to initiate nodejs for GitHub Copilot.
+Recommended to leave as default.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"\${pkgs.nodejs-slim.out}/bin/node"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/assistant/copilot/copilot.nix#blob-path" target="_top">
+                    &lt;neovim-flake/modules/assistant/copilot/copilot.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.assistant.copilot.copilotNodePackage"></a><a class="term" href="options.html#opt-vim.assistant.copilot.copilotNodePackage"><code class="option">vim.assistant.copilot.copilotNodePackage</code></a></span></dt><dd><p>The nodeJS package that will be used for GitHub Copilot. If you are using a custom node command
+you may want to set this option to null so that the package is not pulled from nixpkgs.</p><p><span class="emphasis"><em>Type:</em></span> null or package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">&lt;derivation nodejs-slim-18.16.1&gt;</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/assistant/copilot/copilot.nix#blob-path" target="_top">
                     &lt;neovim-flake/modules/assistant/copilot/copilot.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.assistant.copilot.mappings.panel.accept"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.panel.accept"><code class="option">vim.assistant.copilot.mappings.panel.accept</code></a></span></dt><dd><p>Accept suggestion</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"&lt;CR&gt;"</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/assistant/copilot/copilot.nix#blob-path" target="_top">
                     &lt;neovim-flake/modules/assistant/copilot/copilot.nix&gt;
@@ -1104,7 +1108,7 @@ Thus, it will not be wrapped in `""`.</p><p><span class="emphasis"><em>Type:</em
                     &lt;neovim-flake/modules/ui/notifications/nvim-notify/nvim-notify.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.notify.nvim-notify.timeout"></a><a class="term" href="options.html#opt-vim.notify.nvim-notify.timeout"><code class="option">vim.notify.nvim-notify.timeout</code></a></span></dt><dd><p>The timeout of the notification</p><p><span class="emphasis"><em>Type:</em></span> signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">1000</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/ui/notifications/nvim-notify/nvim-notify.nix#blob-path" target="_top">
                     &lt;neovim-flake/modules/ui/notifications/nvim-notify/nvim-notify.nix&gt;
-                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.optPlugins"></a><a class="term" href="options.html#opt-vim.optPlugins"><code class="option">vim.optPlugins</code></a></span></dt><dd><p>List of plugins to optionally load</p><p><span class="emphasis"><em>Type:</em></span> list of (null or one of "nvim-treesitter-context", "gitsigns-nvim", "plenary-nvim", "nvim-lspconfig", "nvim-treesitter", "lspsaga", "lspkind", "nvim-lightbulb", "lsp-signature", "nvim-tree-lua", "nvim-bufferline-lua", "lualine", "nvim-compe", "nvim-autopairs", "nvim-ts-autotag", "nvim-web-devicons", "tokyonight", "bufdelete-nvim", "nvim-cmp", "cmp-nvim-lsp", "cmp-buffer", "cmp-vsnip", "cmp-path", "cmp-treesitter", "crates-nvim", "vim-vsnip", "nvim-code-action-menu", "trouble", "null-ls", "which-key", "indent-blankline", "nvim-cursorline", "sqls-nvim", "glow-nvim", "telescope", "rust-tools", "onedark", "catppuccin", "dracula", "minimap-vim", "dashboard-nvim", "alpha-nvim", "scrollbar-nvim", "codewindow-nvim", "nvim-notify", "cinnamon-nvim", "cheatsheet-nvim", "ccc", "cellular-automaton", "presence-nvim", "icon-picker-nvim", "dressing-nvim", "orgmode-nvim", "obsidian-nvim", "vim-markdown", "tabular", "toggleterm-nvim", "noice-nvim", "nui-nvim", "copilot-lua", "tabnine-nvim", "nvim-session-manager", "gesture-nvim", "comment-nvim", "kommentary", "mind-nvim", "fidget-nvim", "diffview-nvim", "todo-comments", "flutter-tools", "flutter-tools-patched", "hop-nvim", "leap-nvim", "modes-nvim", "vim-repeat", "smartcolumn", "project-nvim", "elixir-ls", "elixir-tools", "nvim-colorizer-lua", "vim-illuminate", "nvim-surround", "nvim-dap", "nvim-dap-ui" or package)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/core#blob-path" target="_top">
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.optPlugins"></a><a class="term" href="options.html#opt-vim.optPlugins"><code class="option">vim.optPlugins</code></a></span></dt><dd><p>List of plugins to optionally load</p><p><span class="emphasis"><em>Type:</em></span> list of (null or one of "nvim-treesitter-context", "gitsigns-nvim", "plenary-nvim", "nvim-lspconfig", "nvim-treesitter", "lspsaga", "lspkind", "nvim-lightbulb", "lsp-signature", "nvim-tree-lua", "nvim-bufferline-lua", "lualine", "nvim-compe", "nvim-autopairs", "nvim-ts-autotag", "nvim-web-devicons", "tokyonight", "bufdelete-nvim", "nvim-cmp", "cmp-nvim-lsp", "cmp-buffer", "cmp-vsnip", "cmp-path", "cmp-treesitter", "crates-nvim", "vim-vsnip", "nvim-code-action-menu", "trouble", "null-ls", "which-key", "indent-blankline", "nvim-cursorline", "sqls-nvim", "glow-nvim", "telescope", "rust-tools", "onedark", "catppuccin", "dracula", "minimap-vim", "dashboard-nvim", "alpha-nvim", "scrollbar-nvim", "codewindow-nvim", "nvim-notify", "cinnamon-nvim", "cheatsheet-nvim", "ccc", "cellular-automaton", "presence-nvim", "icon-picker-nvim", "dressing-nvim", "orgmode-nvim", "obsidian-nvim", "vim-markdown", "tabular", "toggleterm-nvim", "noice-nvim", "nui-nvim", "copilot-lua", "tabnine-nvim", "nvim-session-manager", "gesture-nvim", "comment-nvim", "kommentary", "mind-nvim", "fidget-nvim", "diffview-nvim", "todo-comments", "flutter-tools", "flutter-tools-patched", "hop-nvim", "leap-nvim", "modes-nvim", "vim-repeat", "smartcolumn", "project-nvim", "elixir-ls", "elixir-tools", "nvim-colorizer-lua", "vim-illuminate", "nvim-surround", "nvim-dap", "nvim-dap-ui", "copilot-cmp" or package)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/core#blob-path" target="_top">
                     &lt;neovim-flake/modules/core&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.presence.presence-nvim.enable"></a><a class="term" href="options.html#opt-vim.presence.presence-nvim.enable"><code class="option">vim.presence.presence-nvim.enable</code></a></span></dt><dd><p>Whether to enable presence.nvim plugin for discord rich presence.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/rich-presence/presence-nvim/presence-nvim.nix#blob-path" target="_top">
                     &lt;neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix&gt;
@@ -1217,7 +1221,7 @@ Thus, it will not be wrapped in `""`.</p><p><span class="emphasis"><em>Type:</em
                     &lt;neovim-flake/modules/basic/module.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.splitRight"></a><a class="term" href="options.html#opt-vim.splitRight"><code class="option">vim.splitRight</code></a></span></dt><dd><p>New splits will open to the right</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/basic/module.nix#blob-path" target="_top">
                     &lt;neovim-flake/modules/basic/module.nix&gt;
-                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.startPlugins"></a><a class="term" href="options.html#opt-vim.startPlugins"><code class="option">vim.startPlugins</code></a></span></dt><dd><p>List of plugins to startup.</p><p><span class="emphasis"><em>Type:</em></span> list of (null or one of "nvim-treesitter-context", "gitsigns-nvim", "plenary-nvim", "nvim-lspconfig", "nvim-treesitter", "lspsaga", "lspkind", "nvim-lightbulb", "lsp-signature", "nvim-tree-lua", "nvim-bufferline-lua", "lualine", "nvim-compe", "nvim-autopairs", "nvim-ts-autotag", "nvim-web-devicons", "tokyonight", "bufdelete-nvim", "nvim-cmp", "cmp-nvim-lsp", "cmp-buffer", "cmp-vsnip", "cmp-path", "cmp-treesitter", "crates-nvim", "vim-vsnip", "nvim-code-action-menu", "trouble", "null-ls", "which-key", "indent-blankline", "nvim-cursorline", "sqls-nvim", "glow-nvim", "telescope", "rust-tools", "onedark", "catppuccin", "dracula", "minimap-vim", "dashboard-nvim", "alpha-nvim", "scrollbar-nvim", "codewindow-nvim", "nvim-notify", "cinnamon-nvim", "cheatsheet-nvim", "ccc", "cellular-automaton", "presence-nvim", "icon-picker-nvim", "dressing-nvim", "orgmode-nvim", "obsidian-nvim", "vim-markdown", "tabular", "toggleterm-nvim", "noice-nvim", "nui-nvim", "copilot-lua", "tabnine-nvim", "nvim-session-manager", "gesture-nvim", "comment-nvim", "kommentary", "mind-nvim", "fidget-nvim", "diffview-nvim", "todo-comments", "flutter-tools", "flutter-tools-patched", "hop-nvim", "leap-nvim", "modes-nvim", "vim-repeat", "smartcolumn", "project-nvim", "elixir-ls", "elixir-tools", "nvim-colorizer-lua", "vim-illuminate", "nvim-surround", "nvim-dap", "nvim-dap-ui" or package)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/core#blob-path" target="_top">
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.startPlugins"></a><a class="term" href="options.html#opt-vim.startPlugins"><code class="option">vim.startPlugins</code></a></span></dt><dd><p>List of plugins to startup.</p><p><span class="emphasis"><em>Type:</em></span> list of (null or one of "nvim-treesitter-context", "gitsigns-nvim", "plenary-nvim", "nvim-lspconfig", "nvim-treesitter", "lspsaga", "lspkind", "nvim-lightbulb", "lsp-signature", "nvim-tree-lua", "nvim-bufferline-lua", "lualine", "nvim-compe", "nvim-autopairs", "nvim-ts-autotag", "nvim-web-devicons", "tokyonight", "bufdelete-nvim", "nvim-cmp", "cmp-nvim-lsp", "cmp-buffer", "cmp-vsnip", "cmp-path", "cmp-treesitter", "crates-nvim", "vim-vsnip", "nvim-code-action-menu", "trouble", "null-ls", "which-key", "indent-blankline", "nvim-cursorline", "sqls-nvim", "glow-nvim", "telescope", "rust-tools", "onedark", "catppuccin", "dracula", "minimap-vim", "dashboard-nvim", "alpha-nvim", "scrollbar-nvim", "codewindow-nvim", "nvim-notify", "cinnamon-nvim", "cheatsheet-nvim", "ccc", "cellular-automaton", "presence-nvim", "icon-picker-nvim", "dressing-nvim", "orgmode-nvim", "obsidian-nvim", "vim-markdown", "tabular", "toggleterm-nvim", "noice-nvim", "nui-nvim", "copilot-lua", "tabnine-nvim", "nvim-session-manager", "gesture-nvim", "comment-nvim", "kommentary", "mind-nvim", "fidget-nvim", "diffview-nvim", "todo-comments", "flutter-tools", "flutter-tools-patched", "hop-nvim", "leap-nvim", "modes-nvim", "vim-repeat", "smartcolumn", "project-nvim", "elixir-ls", "elixir-tools", "nvim-colorizer-lua", "vim-illuminate", "nvim-surround", "nvim-dap", "nvim-dap-ui", "copilot-cmp" or package)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">[ ]</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/core#blob-path" target="_top">
                     &lt;neovim-flake/modules/core&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-vim.statusline.lualine.enable"></a><a class="term" href="options.html#opt-vim.statusline.lualine.enable"><code class="option">vim.statusline.lualine.enable</code></a></span></dt><dd><p>Whether to enable lualine statusline plugin.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/notashelf/neovim-flake/blob/main/modules/statusline/lualine/lualine.nix#blob-path" target="_top">
                     &lt;neovim-flake/modules/statusline/lualine/lualine.nix&gt;