chore(build): auto-generate vimdoc

This commit is contained in:
github-actions[bot] 2023-01-11 14:52:51 +00:00
parent 052b17bc51
commit 94e5446f92

View file

@ -51,27 +51,37 @@ GETTING STARTED *LazyVim-getting-started*
You can find a starter template for **LazyVim** here
<https://github.com/LazyVim/starter>
**TLDR:**
Try it with Docker
>lua
require("lazy").setup({
spec = {
-- import LazyVim plugins
{ "LazyVim/LazyVim", import = "lazyvim.plugins" },
-- import/override with your plugins
{ import = "plugins" },
-- import any extras modules here
-- { import = "lazyvim.plugins.extras.lang.typescript" },
-- { import = "lazyvim.plugins.extras.lang.json" },
},
defaults = {
lazy = true, -- every plugin is lazy-loaded by default
version = "", -- try installing the latest stable version for plugins that support semver
},
})
>sh
docker run -w /root -it --rm alpine:edge sh -uelic '
apk add git lazygit neovim ripgrep alpine-sdk --update
git clone https://github.com/LazyVim/starter ~/.config/nvim
cd ~/.config/nvim
nvim
'
<
Install the <a href="https://github.com/LazyVim/starter">LazyVim Starter</a>
- Make a backup of your current Neovim files:
>sh
mv ~/.config/nvim ~/.config/nvim.bak
mv ~/.local/share/nvim ~/.local/share/nvim.bak
<
- Clone the starter
>sh
git clone https://github.com/LazyVim/starter ~/.config/nvim
<
- Start Neovim!
>sh
nvim
<
Refer to the comments in the files on how to customize **LazyVim**.
FILE STRUCTURE *LazyVim-file-structure*
The files under config will be automatically loaded at the appropriate time, so
@ -99,7 +109,23 @@ be automatically loaded by lazy.nvim <https://github.com/folke/lazy.nvim>
CONFIGURATION *LazyVim-configuration*
**LazyVim** comes with the following defaults:
**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",
}
}
}
<
Default Settings
>lua
{
@ -162,22 +188,6 @@ CONFIGURATION *LazyVim-configuration*
<
**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