Skip to content

Flower101010/neovim-config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

💤 MyNeovim

My template for LazyVim.

✨ Features

  • 🔥 Transform your Neovim into a full-fledged IDE
  • 💤 Easily customize and extend your config with lazy.nvim
  • 🚀 Blazingly fast
  • 🧹 Sane default settings for options, autocmds, and keymaps
  • 📦 Comes with a wealth of plugins pre-configured and ready to use

⚡️ Requirements

  • Neovim >= 0.9.0 (needs to be built with LuaJIT)
  • Git >= 2.19.0 (for partial clones support)
  • a Nerd Font(v3.0 or greater) (optional, but needed to display some icons)
  • lazygit (optional)
  • a C compiler for nvim-treesitter. See here
  • for telescope.nvim (optional)
  • a terminal that support true color and undercurl:

🛠️ Installation

Linux/MacOS

  • Make a backup of your current Neovim files:

    # required
    mv ~/.config/nvim{,.bak}
    
    # optional but recommended
    mv ~/.local/share/nvim{,.bak}
    mv ~/.local/state/nvim{,.bak}
    mv ~/.cache/nvim{,.bak}
  • Clone the starter

    git clone https://github.com/Flower101010/neovim-config ~/.config/nvim
  • Remove the .git folder, so you can add it to your own repo later

    rm -rf ~/.config/nvim/.git
  • Start Neovim!

    nvim

    Refer to the comments in the files on how to customize LazyVim.

Windows

Install the template with PowerShell

  • Make a backup of your current Neovim files:

    # required
    Move-Item $env:LOCALAPPDATA\nvim $env:LOCALAPPDATA\nvim.bak
    
    # optional but recommended
    Move-Item $env:LOCALAPPDATA\nvim-data $env:LOCALAPPDATA\nvim-data.bak
  • Clone the starter

    git clone https://github.com/Flower101010/neovim-config $env:LOCALAPPDATA\nvim
  • Remove the .git folder, so you can add it to your own repo later

    Remove-Item $env:LOCALAPPDATA\nvim\.git -Recurse -Force
  • Start Neovim!

    nvim

    Refer to the comments in the files on how to customize LazyVim.

docker

docker run -w /root -it --rm alpine:edge sh -uelic '
  apk add git lazygit neovim ripgrep alpine-sdk --update
  git clone https://github.com/Flower101010/neovim-config ~/.config/nvim
  cd ~/.config/nvim
  nvim
'

TIP

It is recommended to run :LazyHealth after installation. This will load all plugins and check if everything is working correctly.

📂 File Structure

The files under config will be automatically loaded at the appropriate time, so you don't need to require those files manually. LazyVim comes with a set of default config files that will be loaded before your own. See here

You can add your custom plugin specs under lua/plugins/. All files there will be automatically loaded by lazy.nvim

~/.config/nvim
├── lua
│   ├── config
│   │   ├── autocmds.lua
│   │   ├── keymaps.lua
│   │   ├── lazy.lua
│   │   └── options.lua
│   └── plugins
│       ├── spec1.lua
│       ├── **
│       └── spec2.lua
└── init.lua

About

My Neovim configuration

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages