nvimdots

## 🪷 Introduction This repo hosts our [Neovim](https://neovim.io/) configuration for Linux [(with NixOS support)](#nixos-support), macOS, and Windows. `init.lua` is the config entry point. Branch info:

| Branch | Supported Neovim version | | :----: | :----------------------: | | main | nvim 0.10 stable | | 0.11 | nvim 0.11 nightly | | 0.9 | nvim 0.9 | | 0.8 | nvim 0.8 |

> [!IMPORTANT] > The `0.11` branch is intended for nightly Neovim builds and is **not** stable. It typically harbors subtle issues scattered throughout. Therefore, refrain from submitting issues if you happen to encounter them. They will be closed directly unless a viable solution is proposed or included. We currently manage plugins using [lazy.nvim](https://github.com/folke/lazy.nvim). Chinese introduction is [here](https://zhuanlan.zhihu.com/p/382092667). ### 🎐 Features - **Fast.** Less than **50ms** to start (Depends on SSD and CPU, tested on Zephyrus G14 2022 version). - **Simple.** Runs out of the box. - **Modern.** Pure `lua` config. - **Modular.** Easy to customize. - **Powerful.** Full functionality to code. ## 🏗 How to Install Simply run the following interactive bootstrap command, and you should be all set 👍 - **Windows** _(Note: This script REQUIRES `pwsh` > `v7.1`)_ ```pwsh 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** ```sh 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](https://github.com/ayamir/nvimdots/wiki/Prerequisites) before starting, especially for \*nix users. ## ⚙️ Configuration & Usage

🗺️ Keybindings

See Wiki: Keybindings for details

🔌 Plugins & Deps

See Wiki: Plugins for details
(You can also find a deps diagram there!)

🔧 Usage & Customization

See Wiki: Usage for details

❄️ NixOS Support

See Wiki: NixOS Support for details

🤔 FAQ

See Wiki: FAQ for details

## ✨ Features

⏱️ Startup Time

StartupTime

Vim-StartupTime

> Tested with [rhysd/vim-startuptime](https://github.com/rhysd/vim-startuptime)

📸 Screenshots

Dashboard

Telescope

Coding Coding

Code Action

Debugging

Lazygit Lazygit with built-in Terminal

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 - [ayamir](https://github.com/ayamir) - [Jint-lzxy](https://github.com/Jint-lzxy) - [CharlesChiuGit](https://github.com/CharlesChiuGit) - [aarnphm](https://github.com/aarnphm) - [misumisumi](https://github.com/misumisumi) ## 🎉 Acknowledgement - [glepnir/nvim](https://github.com/glepnir/nvim) ## 📜 License This Neovim configuration is released under the BSD 3-Clause license, which grants the following permissions: - Commercial use - Distribution - Modification - Private use For more convoluted language, see the [LICENSE](https://github.com/ayamir/nvimdots/blob/main/LICENSE).