Vim-fork focused on extensibility and usability
Go to file
Justin M. Keyes 317b133a7e docs: no meta info for deprecated functions
A central tenet of our deprecation strategy is that deprecated functions
must have zero footprint in docs, auto-completion, and meta structures.
2024-12-02 16:17:30 +01:00
.github ci: remove myself from lsp reviewers 2024-11-27 13:16:06 +01:00
cmake build: specify POST_BUILD when using add_custom_command 2024-11-09 13:07:16 +01:00
cmake.config test: port libvterm unit test to neovim test suite 2024-10-22 21:20:11 +02:00
cmake.deps build(deps): bump luajit to HEAD - 19878ec05 2024-11-29 09:08:52 +01:00
cmake.packaging fix(win-msi): set installer scope to machine #29895 2024-08-12 12:11:40 -07:00
contrib docs: dev-arch, focusable windows #30510 2024-10-07 08:27:38 -07:00
runtime docs: no meta info for deprecated functions 2024-12-02 16:17:30 +01:00
scripts docs: no meta info for deprecated functions 2024-12-02 16:17:30 +01:00
src fix(extmark): builtin completion can still affect nearby extmarks #31387 2024-12-02 06:11:38 -08:00
test fix(extmark): builtin completion can still affect nearby extmarks #31387 2024-12-02 06:11:38 -08:00
.cirrus.yml vim-patch:9.0.1892: CI: no FreeBSD 14 support (#26604) 2023-12-16 21:12:31 +08:00
.clang-format build: align .clang-format rules with uncrustify config 2023-05-28 15:39:43 +02:00
.clang-tidy build: fix or silence new clang-tidy warnings 2024-09-25 16:09:08 +02:00
.clangd build: disable UnusedIncludes from clangd 2023-11-28 20:22:59 +01:00
.editorconfig fix(editorconfig): fix indent style for local.mk (#31342) 2024-11-24 22:04:27 -06:00
.git-blame-ignore-revs docs: .git-blame-ignore-revs #26397 2024-01-28 15:03:10 -08:00
.gitattributes feat: generate types and docs for v variables 2023-12-21 14:19:10 +00:00
.gitignore vim-patch: make gen_opt_test.vim work with Nvim (#30850) 2024-10-18 17:38:29 +08:00
.luacheckrc test(lsp): refactor and tidy 2024-08-11 15:14:14 +01:00
.luacov Lua: vim.validate() 2019-11-10 22:50:24 -08:00
.luarc.json refactor: fix luals warnings 2023-12-30 17:40:53 +01:00
.mailmap docs: misc (#28837) 2024-06-07 10:55:14 +08:00
.stylua.toml build: enable lintlua for scripts/ dir #26391 2023-12-04 12:38:31 -08:00
.styluaignore build: enable lintlua for test/ dir 2024-01-03 02:09:28 +01:00
BSDmakefile feat(lua)!: register_keystroke_callback => on_key 2021-09-09 06:09:33 -07:00
BUILD.md docs(build): suggest ucrt64 for msys2 #31312 2024-11-24 07:44:37 -08:00
CMakeLists.txt docs: misc 2024-10-23 14:13:42 +02:00
CMakePresets.json build: add "ci" configure preset to reduce verbosity 2023-04-23 17:12:46 +02:00
CONTRIBUTING.md docs: misc (#28837) 2024-06-07 10:55:14 +08:00
INSTALL.md docs: misc (#29719) 2024-08-29 06:11:32 +08:00
LICENSE.txt vim-patch:e978b4534a5e (#24697) 2023-08-13 13:25:10 +01:00
MAINTAIN.md fix(lua): vim.deprecate does not support major>0 2024-10-21 00:54:42 +02:00
Makefile build: work around bug in make when PATH includes cmake as dir 2024-09-20 22:16:34 +02:00
README.md docs(tui): rename term.txt, nvim_terminal_emulator.txt #30398 2024-09-18 00:26:01 -07:00

Neovim

Documentation | Chat

Coverity Scan analysis Packages Debian CI Downloads

Neovim is a project that seeks to aggressively refactor Vim in order to:

See the Introduction wiki page and Roadmap for more information.

Features

See :help nvim-features for the full list, and :help news for noteworthy changes in the latest version!

Install from package

Pre-built packages for Windows, macOS, and Linux are found on the Releases page.

Managed packages are in Homebrew, Debian, Ubuntu, Fedora, Arch Linux, Void Linux, Gentoo, and more!

Install from source

See BUILD.md and supported platforms for details.

The build is CMake-based, but a Makefile is provided as a convenience. After installing the dependencies, run the following command.

make CMAKE_BUILD_TYPE=RelWithDebInfo
sudo make install

To install to a non-default location:

make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=/full/path/
make install

CMake hints for inspecting the build:

  • cmake --build build --target help lists all build targets.
  • build/CMakeCache.txt (or cmake -LAH build/) contains the resolved values of all CMake variables.
  • build/compile_commands.json shows the full compiler invocations for each translation unit.

Transitioning from Vim

See :help nvim-from-vim for instructions.

Project layout

├─ cmake/           CMake utils
├─ cmake.config/    CMake defines
├─ cmake.deps/      subproject to fetch and build dependencies (optional)
├─ runtime/         plugins and docs
├─ src/nvim/        application source code (see src/nvim/README.md)
│  ├─ api/          API subsystem
│  ├─ eval/         Vimscript subsystem
│  ├─ event/        event-loop subsystem
│  ├─ generators/   code generation (pre-compilation)
│  ├─ lib/          generic data structures
│  ├─ lua/          Lua subsystem
│  ├─ msgpack_rpc/  RPC subsystem
│  ├─ os/           low-level platform code
│  └─ tui/          built-in UI
└─ test/            tests (see test/README.md)

License

Neovim contributions since b17d96 are licensed under the Apache 2.0 license, except for contributions copied from Vim (identified by the vim-patch token). See LICENSE for details.

Vim is Charityware.  You can use and copy it as much as you like, but you are
encouraged to make a donation for needy children in Uganda.  Please see the
kcc section of the vim docs or visit the ICCF web site, available at these URLs:

        https://iccf-holland.org/
        https://www.vim.org/iccf/
        https://www.iccf.nl/

You can also sponsor the development of Vim.  Vim sponsors can vote for
features.  The money goes to Uganda anyway.