README.md

Introduction

This is my personal Neovim configuration, you can use it directly.

Chinese user see this 中文文档

Features

• Install plugins and LSP automatically
• Pure Lua configuration
• Modular design
• Focus on core programming functionalities
• Fast startup time (40~50ms)
• Cross platform (Windows and GNU/Linux)

Prerequisites

Must:

• Latest neovim nightly.

• SourceCodePro Nerd Font: Display icons and default fonts for nvim-qt.

• Install LSP automatically:

  • GNU/Linux: git(1), curl(1) or wget(1), unzip(1), tar(1), gzip(1)
  • Windows: powershell, git, tar, and 7zip or peazip or archiver or winzip or WinRAR
  • Lsp specific Prerequisites: for example, gopls needs go.

• Compile treesitter：

  • C toolchain, Windows user see this.

• Debug Adapter: lldb-vscode for C++, Delve for Golang.

Optional

• ripgrep: Improve text search performance.
• fd：Improve file search performance.
• Other development tools you need.

NOTE:

• Windows user can install dependencies using msys2 and chocolatey.

Installation

Clone this repository to your Neovim configuration directory.

git clone --depth 1 https://github.com:kongjun18/nvim.git <configuration directory>

All plugins are automatically installed on first startup, do not close Neovim until the installation is complete.

NOTE:

• If you exit during installation or the plugin is not cloned due to network reasons, you may need to manually delete the plugin and reinstall it.

FAQ

1. How to disable and enable wakatime/codeium/yadm/obsidian and custom obsidian path?

Set variables in lua/modules/config/init.lua like wakatime_enable to false.

Credits

• ayamir/nvimdots
• All plugins my configuration used