mirror of
https://github.com/LazyVim/LazyVim.git
synced 2025-07-31 08:04:39 +02:00
docs: simplified and add docker
This commit is contained in:
parent
318b56c1c4
commit
052b17bc51
1 changed files with 52 additions and 32 deletions
84
README.md
84
README.md
|
@ -26,26 +26,44 @@ to tweak your config as needed, along with the convenience of a pre-configured s
|
||||||
|
|
||||||
You can find a starter template for **LazyVim** [here](https://github.com/LazyVim/starter)
|
You can find a starter template for **LazyVim** [here](https://github.com/LazyVim/starter)
|
||||||
|
|
||||||
**TLDR:**
|
<details><summary>Try it with Docker</summary>
|
||||||
|
|
||||||
```lua
|
```sh
|
||||||
require("lazy").setup({
|
docker run -w /root -it --rm alpine:edge sh -uelic '
|
||||||
spec = {
|
apk add git lazygit neovim ripgrep alpine-sdk --update
|
||||||
-- import LazyVim plugins
|
git clone https://github.com/LazyVim/starter ~/.config/nvim
|
||||||
{ "LazyVim/LazyVim", import = "lazyvim.plugins" },
|
cd ~/.config/nvim
|
||||||
-- import/override with your plugins
|
nvim
|
||||||
{ 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
|
|
||||||
},
|
|
||||||
})
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details><summary>Install the <a href="https://github.com/LazyVim/starter">LazyVim Starter</a></summary>
|
||||||
|
|
||||||
|
- 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**.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## 📂 File Structure
|
## 📂 File Structure
|
||||||
|
|
||||||
The files under config will be automatically loaded at the appropriate time,
|
The files under config will be automatically loaded at the appropriate time,
|
||||||
|
@ -73,7 +91,22 @@ will be automatically loaded by [lazy.nvim](https://github.com/folke/lazy.nvim)
|
||||||
|
|
||||||
## ⚙️ Configuration
|
## ⚙️ 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",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
<details><summary>Default Settings</summary>
|
||||||
|
|
||||||
<!-- config:start -->
|
<!-- config:start -->
|
||||||
|
|
||||||
|
@ -139,20 +172,7 @@ will be automatically loaded by [lazy.nvim](https://github.com/folke/lazy.nvim)
|
||||||
|
|
||||||
<!-- config:end -->
|
<!-- config:end -->
|
||||||
|
|
||||||
**LazyVim** can be configured in the same way as any other plugin.
|
</details>
|
||||||
|
|
||||||
For example in `lua/plugins/core.lua`
|
|
||||||
|
|
||||||
```lua
|
|
||||||
return {
|
|
||||||
{
|
|
||||||
"LazyVim/LazyVim",
|
|
||||||
opts = {
|
|
||||||
colorscheme = "catppuccin",
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🚀 Configuring **Plugins**
|
## 🚀 Configuring **Plugins**
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue