kickstart.nvim/README.md

Introduction

A starting point for neovim that is:

• Small (~325 lines)
• Single-file
• Documented
• Modular

Kickstart targets only the latest stable neovim release (0.7) and the nightly.

This repo is meant to be used as a starting point for a user's own configuration; remove the things you don't use and add what you miss. This configuration serves as the reference configuration for the lspconfig wiki.

See the wiki for additional tips, tricks, and recommended plugins.

Installation

• Backup your previous configuration
• Copy and paste the kickstart.nvim init.lua into $HOME/.config/nvim/init.lua
• start neovim (nvim) and run :PackerInstall, ignore any error message about missing plugins, :PackerInstall will fix that shortly.
• restart neovim

Contribution

Pull-requests are welcome. The goal of this repo is not to create a neovim configuration framework, but to offer a starting template that shows, by example, available features in neovim. Some things that will not be included:

• Custom language server configuration (null-ls templates)
• Theming beyond a default colorscheme necessary for LSP highlight groups
• Lazy-loading. Kickstart.nvim should start within 40 ms on modern hardware. Please profile and contribute to upstream plugins to optimize startup time instead.

Each PR, especially those which increase the line count, should have a description as to why the PR is necessary.