/nvimdots

A well configured and structured Neovim.

Primary LanguageLuaMIT LicenseMIT

nvimdots
NeoVim Version Capability Release

Stars Issues Contributors Code Size

πŸͺ· Introduction

This repo hosts my NeoVim configuration for Linux, macOS, and Windows. init.lua is the config entry point.

Branch info:

Branch Supported neovim version
main nvim 0.9 stable
0.8 nvim 0.8
0.7 nvim 0.7

I use lazy.nvim to manage plugins.

Chinese introduction is here.

🎐 Features

  • Fast. Less than 30ms to start (Depends on SSD and CPU, tested on Zephyrus G14 2022 version).
  • Simple. Run out of the box.
  • Modern. Pure lua config.
  • Modular. Easy to customize.
  • Powerful. Full functionality to code.

πŸ— How to Install

Just run the following interactive bootstrap command, and you're good to go πŸ‘

  • Windows (Note: This script REQUIRES pwsh > v7.1)
Set-ExecutionPolicy Bypass -Scope Process -Force; Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/scripts/install.ps1'))
  • *nix
if command -v curl >/dev/null 2>&1; then
    bash -c "$(curl -fsSL https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/scripts/install.sh)"
else
    bash -c "$(wget -O- https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/scripts/install.sh)"
fi

It's strongly recommended to read Wiki: Prerequisites before starting, especially for *nix users.

βš™οΈ Configuration & Usage

πŸ—ΊοΈ Keybindings

Refer to Wiki: Keybindings


πŸ”Œ Plugins & Deps

Refer to Wiki: Plugins
(You can also find a deps diagram there!)


πŸ”§ Usage & Customization

Refer to Wiki: Usage


πŸ€” FAQ

Refer to Wiki: FAQ

✨ Features

⏱️ Startup Time

StartupTime

Vim-StartupTime

Tested with rhysd/vim-startuptime

πŸ“Έ Screenshots

Dashboard Dashboard


Telescope Telescope


Coding Coding


Code Action Code Action


Debugging Debugging


Lazygit Lazygit with built-in Terminal


Command quickref Command quickref

πŸ‘ Contributing

  • If you find anything that needs improving, do not hesitate to point it out or create a PR.
  • If you come across an issue, you can first use :checkhealth command provided by nvim to trouble-shoot yourself.
    • If you still have such problems, feel free to open a new issue!

❀️ Thanks to

πŸŽ‰ Acknowledgement

πŸ“œ License

This NeoVim configuration is released under the MIT license, which grants the following permissions:

  • Commercial use
  • Distribution
  • Modification
  • Private use

For more convoluted language, see the LICENSE.