mirror of
https://github.com/LazyVim/LazyVim.git
synced 2025-07-21 03:05:20 +02:00
chore(build): auto-generate vimdoc
This commit is contained in:
github-actions[bot]
parent
f22c21c52f
commit
9d69c7f473
1 changed files with 123 additions and 11 deletions
134
doc/LazyVim.txt
134
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 <https://github.com/folke/lazy.nvim>
|
|||
init.toml
|
||||
</pre>
|
||||
|
||||
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: <code>lua/plugins/example.lua</code>
|
|||
-- 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: <code>lua/plugins/example.lua</code>
|
|||
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: <code>lua/plugins/example.lua</code>
|
|||
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: <code>lua/plugins/example.lua</code>
|
|||
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: <code>lua/plugins/example.lua</code>
|
|||
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: <code>lua/plugins/example.lua</code>
|
|||
},
|
||||
|
||||
-- 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
|
|||
│<A-k> │Move up │**n**, **v**, **i** │
|
||||
│<S-h> │Prev buffer │**n** │
|
||||
│<S-l> │Next buffer │**n** │
|
||||
│[p │Paste below │**n** │
|
||||
│]p │Paste above │**n** │
|
||||
│<esc> │Escape and clear hlsearch │**i**, **n** │
|
||||
│<leader>r │Redraw and clear hlsearch │**n** │
|
||||
│n │Next search result │**n**, **x**, **o** │
|
||||
│N │Prev search result │**n**, **x**, **o** │
|
||||
│<C-s> │Save file │**i**, **v**, **n**, **s**│
|
||||
|
|
@ -393,6 +502,8 @@ Plugins
|
|||
│<leader>bD │mini.bufremove <https://github.com/echasnovski/mini.bufremove.git> Delete Buffer (Force) │**n**│
|
||||
│<leader>ft │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> NeoTree (root dir) │**n**│
|
||||
│<leader>fT │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> NeoTree (cwd) │**n**│
|
||||
│<leader>e │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> NeoTree (root dir) │**n**│
|
||||
│<leader>E │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> NeoTree (cwd) │**n**│
|
||||
│<S-Enter> │noice.nvim <https://github.com/folke/noice.nvim.git> Redirect Cmdline │**c**│
|
||||
│<leader>nl │noice.nvim <https://github.com/folke/noice.nvim.git> Noice Last Message │**n**│
|
||||
│<leader>nh │noice.nvim <https://github.com/folke/noice.nvim.git> Noice History │**n**│
|
||||
|
|
@ -457,6 +568,7 @@ Core
|
|||
- gitsigns.nvim <https://github.com/lewis6991/gitsigns.nvim>
|
||||
- indent-blankline.nvim <https://github.com/lukas-reineke/indent-blankline.nvim>
|
||||
- lazy.nvim <https://github.com/folke/lazy.nvim>
|
||||
- LazyVim <https://github.com/LazyVim/LazyVim>
|
||||
- leap.nvim <https://github.com/ggandor/leap.nvim>
|
||||
- lualine.nvim <https://github.com/nvim-lualine/lualine.nvim>
|
||||
- LuaSnip <https://github.com/L3MON4D3/LuaSnip>
|
||||
|
|
@ -513,7 +625,7 @@ To use this, add it to your **lazy.nvim** imports:
|
|||
|
||||
- nvim-lspconfig <https://github.com/neovim/nvim-lspconfig>
|
||||
- nvim-treesitter <https://github.com/nvim-treesitter/nvim-treesitter>
|
||||
- schemastore.nvim <https://github.com/b0o/schemastore.nvim>
|
||||
- SchemaStore.nvim <https://github.com/b0o/SchemaStore.nvim>
|
||||
|
||||
|
||||
Extras: <code>lang.typescript</code>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue