Vim-fork focused on extensibility and usability
Go to file
github-actions[bot] 00761ad1e6
[Backport release-0.8] feat(docs): format parameter list as a list (#20588)
feat(docs): format parameter list as a list

Problem:
The {foo} parameters listed in `:help api` and similar generated docs,
are intended to be a "list" but they aren't prefixed with a list symbol.
This prevents parsers from understanding the list, which forces
generators like `gen_help_html.lua` to use hard-wrapped/preformatted
layout instead of a soft-wrapped "flow" layout.

Solution:
Modify gen_vimdoc.py to prefix {foo} parameters with a "•" symbol.

(cherry picked from commit 24e5b5c8c7)

Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
2022-10-11 04:46:30 -07:00
.github ci: use ubuntu docker container to build appimage 2022-10-09 11:53:28 +02:00
ci ci: convert CRLF to LF (#20389) 2022-09-29 14:31:12 +02:00
cmake revert: "build: remove unnecessary policy related code" #20289 2022-09-23 07:16:17 -07:00
cmake.config build: rename build-related dirs 2022-06-28 04:02:29 -07:00
cmake.deps [Backport release-0.8] feat(docs): remove old AWK scripts, update HTML generator (#20587) 2022-10-11 04:19:38 -07:00
cmake.packaging build: rename build-related dirs 2022-06-28 04:02:29 -07:00
contrib fix: cleanup contrib/ #20304 2022-09-23 09:02:16 -07:00
runtime [Backport release-0.8] feat(docs): format parameter list as a list (#20588) 2022-10-11 04:46:30 -07:00
scripts [Backport release-0.8] feat(docs): format parameter list as a list (#20588) 2022-10-11 04:46:30 -07:00
snap cmake: install app icon in XDG hicolor icon theme (#14656) 2021-05-27 22:37:24 +02:00
src refactor: explicitly convert HANDLE to intptr_t for _open_osfhandle() 2022-10-11 03:30:35 +00:00
test [Backport release-0.8] feat(docs): remove old AWK scripts, update HTML generator (#20587) 2022-10-11 04:19:38 -07:00
.cirrus.yml ci(cirrus): set clone depth to 2 instead of 1 (#20295) 2022-09-23 12:57:18 +02:00
.clang-format docs(clang-format): one space in directives indent (#18800) 2022-05-30 23:49:11 +08:00
.clangd Adding clangd language serever config file to point to build/ directory for compile_commands.json 2021-06-28 11:03:09 -04:00
.editorconfig chore(editorconfig): remove "charset" (#18541) 2022-05-12 23:48:42 +08:00
.git-blame-ignore-revs docs: update .git-blame-ignore-revs (#20066) 2022-09-03 10:18:05 +01:00
.gitattributes docs: update .gitattributes (#19800) 2022-08-16 10:51:30 +01:00
.gitignore build: add basic cmake-presets integration (#19128) 2022-09-19 10:58:26 +02:00
.luacheckrc feat(Man): port to Lua (#19912) 2022-09-02 15:20:29 +01:00
.luacov Lua: vim.validate() 2019-11-10 22:50:24 -08:00
.mailmap docs: update .mailmap (#20086) 2022-09-06 08:57:03 +02:00
.stylua.toml refactor(lua): reformat with stylua 0.14.0 (#19264) 2022-07-07 18:27:18 +02:00
.styluaignore ci: lint runtime with stylua 2022-05-09 16:31:55 +02:00
BACKERS.md Update backer URL 2015-11-11 19:50:33 -08:00
BSDmakefile feat(lua)!: register_keystroke_callback => on_key 2021-09-09 06:09:33 -07:00
CMakeLists.txt NVIM v0.8.0 2022-09-30 17:15:13 +02:00
CMakePresets.json build: add basic cmake-presets integration (#19128) 2022-09-19 10:58:26 +02:00
codecov.yml bundle: move tree-sitter as a bundled dep 2020-11-03 10:39:35 +01:00
CONTRIBUTING.md ci: move BSD jobs from sourcehut to Cirrus CI #19616 2022-09-08 15:12:42 -07:00
LICENSE.txt ci: improved cpack packaging 2022-02-24 19:54:44 +10:00
MAINTAIN.md ci(backport): bump to backport-action@v0.0.8 #20366 2022-09-27 05:53:48 -07:00
Makefile feat(docs): gen_help_html.lua 2022-09-22 15:36:27 +02:00
README.md docs: removed outdated coverage link 2022-09-09 20:03:53 -04:00

Neovim

Documentation | Chat | Twitter

GitHub CI Coverity Scan analysis Clang analysis PVS-Studio analysis

Packages Debian CI Downloads nvim

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!

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 the Building Neovim wiki page 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

├─ ci/              build automation
├─ 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/         VimL 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:

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

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