From 9d69c7f473c0813b7fc47ed57a015909d0007310 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 10 Jan 2023 10:15:28 +0000 Subject: [PATCH] chore(build): auto-generate vimdoc --- doc/LazyVim.txt | 134 ++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 123 insertions(+), 11 deletions(-) diff --git a/doc/LazyVim.txt b/doc/LazyVim.txt index ceefe921..fd2b05ad 100644 --- a/doc/LazyVim.txt +++ b/doc/LazyVim.txt @@ -8,7 +8,8 @@ Table of Contents *LazyVim-table-of-contents* - Requirements |LazyVim-requirements| - Getting Started |LazyVim-getting-started| - File Structure |LazyVim-file-structure| - - Configuring **LazyVim** |LazyVim-configuring-**lazyvim**| + - Configuration |LazyVim-configuration| + - Configuring **Plugins** |LazyVim-configuring-**plugins**| - Keymaps |LazyVim-keymaps| - Plugins |LazyVim-plugins| @@ -96,7 +97,88 @@ be automatically loaded by lazy.nvim init.toml -CONFIGURING **LAZYVIM** *LazyVim-configuring-**lazyvim*** +CONFIGURATION *LazyVim-configuration* + +**LazyVim** comes with the following defaults: + +>lua + { + -- colorscheme can be a string like `catppuccin` or a function that will load the colorscheme + ---@type string|fun() + colorscheme = function() + require("tokyonight").load() + end, + -- icons used by other plugins + icons = { + diagnostics = { + Error = " ", + Warn = " ", + Hint = " ", + Info = " ", + }, + git = { + added = " ", + modified = " ", + removed = " ", + }, + kinds = { + Array = " ", + Boolean = " ", + Class = " ", + Color = " ", + Constant = " ", + Constructor = " ", + Enum = " ", + EnumMember = " ", + Event = " ", + Field = " ", + File = " ", + Folder = " ", + Function = " ", + Interface = " ", + Key = " ", + Keyword = " ", + Method = " ", + Module = " ", + Namespace = " ", + Null = " ", + Number = " ", + Object = " ", + Operator = " ", + Package = " ", + Property = " ", + Reference = " ", + Snippet = " ", + String = " ", + Struct = " ", + Text = " ", + TypeParameter = " ", + Unit = " ", + Value = " ", + Variable = " ", + }, + }, + } +< + + +**LazyVim** can be configured in the same way as any other plugin. + +For example in `lua/plugins/core.lua` + +>lua + return { + { + "LazyVim/LazyVim", + opts = { + colorscheme = "catppuccin", + } + } + } +< + + +CONFIGURING **PLUGINS** *LazyVim-configuring-**plugins*** Configuring **LazyVim** is exactly the same as using **lazy.nvim** to build a config from scratch. @@ -114,6 +196,17 @@ Example spec: lua/plugins/example.lua -- disable/enabled LazyVim plugins -- override the configuration of LazyVim plugins return { + -- add gruvbox + { "ellisonleao/gruvbox.nvim" }, + + -- Configure LazyVim to load gruvbox + { + "LazyVim/LazyVim", + opts = { + colorscheme = "gruvbox", + }, + }, + -- change trouble config { "folke/trouble.nvim", @@ -143,10 +236,9 @@ Example spec: lua/plugins/example.lua end, }, - -- change some telescope options and add telescope-fzf-native + -- change some telescope options and a keymap to browse plugin files { "nvim-telescope/telescope.nvim", - dependencies = { { "nvim-telescope/telescope-fzf-native.nvim", build = "make" } }, keys = { -- add a keymap to browse plugin files -- stylua: ignore @@ -165,6 +257,12 @@ Example spec: lua/plugins/example.lua winblend = 0, }, }, + }, + + -- add telescope-fzf-native + { + "nvim-telescope/telescope.nvim", + dependencies = { { "nvim-telescope/telescope-fzf-native.nvim", build = "make" } }, -- apply the config and additionally load fzf-native config = function(_, opts) local telescope = require("telescope") @@ -173,7 +271,20 @@ Example spec: lua/plugins/example.lua end, }, - -- add pyright and setup tsserver with typescript.nvim + -- add pyright to lspconfig + { + "neovim/nvim-lspconfig", + ---@class PluginLspOpts + opts = { + ---@type lspconfig.options + servers = { + -- pyright will be automatically installed with mason and loaded with lspconfig + pyright = {}, + }, + }, + }, + + -- add tsserver and setup with typescript.nvim instead of lspconfig { "neovim/nvim-lspconfig", dependencies = { @@ -190,8 +301,7 @@ Example spec: lua/plugins/example.lua opts = { ---@type lspconfig.options servers = { - -- pyright will be automatically installed with mason and loaded with lspconfig - pyright = {}, + -- tsserver will be automatically installed with mason and loaded with lspconfig tsserver = {}, }, -- you can do any additional lsp server setup here @@ -238,7 +348,7 @@ Example spec: lua/plugins/example.lua }, -- since `vim.tbl_deep_extend`, can only merge tables and not lists, the code above - -- would overwrite `ensure_installed` with the ne value. + -- would overwrite `ensure_installed` with the new value. -- If you'd rather extend the default config, use the code below instead: { "nvim-treesitter/nvim-treesitter", @@ -321,9 +431,8 @@ General │ │Move up │**n**, **v**, **i** │ │ │Prev buffer │**n** │ │ │Next buffer │**n** │ -│[p │Paste below │**n** │ -│]p │Paste above │**n** │ │ │Escape and clear hlsearch │**i**, **n** │ +│r │Redraw and clear hlsearch │**n** │ │n │Next search result │**n**, **x**, **o** │ │N │Prev search result │**n**, **x**, **o** │ │ │Save file │**i**, **v**, **n**, **s**│ @@ -393,6 +502,8 @@ Plugins │bD │mini.bufremove Delete Buffer (Force) │**n**│ │ft │neo-tree.nvim NeoTree (root dir) │**n**│ │fT │neo-tree.nvim NeoTree (cwd) │**n**│ +│e │neo-tree.nvim NeoTree (root dir) │**n**│ +│E │neo-tree.nvim NeoTree (cwd) │**n**│ │ │noice.nvim Redirect Cmdline │**c**│ │nl │noice.nvim Noice Last Message │**n**│ │nh │noice.nvim Noice History │**n**│ @@ -457,6 +568,7 @@ Core - gitsigns.nvim - indent-blankline.nvim - lazy.nvim +- LazyVim - leap.nvim - lualine.nvim - LuaSnip @@ -513,7 +625,7 @@ To use this, add it to your **lazy.nvim** imports: - nvim-lspconfig - nvim-treesitter -- schemastore.nvim +- SchemaStore.nvim Extras: lang.typescript