neovim

mirror of https://github.com/neovim/neovim.git synced 2024-12-23 20:55:18 -07:00

Vim-fork focused on extensibility and usability

Go to file

Justin M. Keyes 09b64d75bd feat(docs): gen_help_html.lua Problem: The :help docs HTML generated is driven by an old awk script `runtime/doc/makehtml.awk` that is hard to maintain (ad hoc parser and no one has touched it in decades) and has bugs like: - https://github.com/neovim/neovim.github.io/issues/96 - https://github.com/neovim/neovim.github.io/issues/97 Solution: Use Lua + treesitter (https://github.com/vigoux/tree-sitter-vimdoc) to generate :help docs HTML. Also validates tag links. fix https://github.com/neovim/neovim.github.io/issues/96 fix https://github.com/neovim/neovim.github.io/issues/97 TODO: - delete doc_html build task - delete runtime/doc/Makefile - delete makehtml.awk - delete maketags.awk OUTPUT: $ nvim -V1 -es --clean +"lua require('scripts.gen_help_html')" output dir: /…/neovim.github.io/_site/doc/ generated (207 errors): api.txt => api.html generated (122 errors): arabic.txt => arabic.html generated (285 errors): autocmd.txt => autocmd.html generated (641 errors): builtin.txt => builtin.html generated (623 errors): change.txt => change.html generated (65 errors): channel.txt => channel.html generated (353 errors): cmdline.txt => cmdline.html generated (3 errors): debug.txt => debug.html generated (28 errors): deprecated.txt => deprecated.html generated (193 errors): dev_style.txt => dev_style.html generated (460 errors): develop.txt => develop.html generated (19 errors): diagnostic.txt => diagnostic.html generated (57 errors): diff.txt => diff.html generated (818 errors): digraph.txt => digraph.html generated (330 errors): editing.txt => editing.html generated (368 errors): eval.txt => eval.html generated (184 errors): fold.txt => fold.html generated (61 errors): ft_ada.txt => ft_ada.html generated (0 errors): ft_ps1.txt => ft_ps1.html generated (20 errors): ft_raku.txt => ft_raku.html generated (5 errors): ft_rust.txt => ft_rust.html generated (41 errors): ft_sql.txt => ft_sql.html generated (110 errors): gui.txt => gui.html generated (79 errors): hebrew.txt => hebrew.html generated (17 errors): help.txt => index.html generated (104 errors): helphelp.txt => helphelp.html generated (0 errors): if_cscop.txt => if_cscop.html generated (23 errors): if_perl.txt => if_perl.html generated (16 errors): if_pyth.txt => if_pyth.html generated (9 errors): if_ruby.txt => if_ruby.html generated (216 errors): indent.txt => indent.html generated (634 errors): index.txt => vimindex.html generated (320 errors): insert.txt => insert.html generated (265 errors): intro.txt => intro.html generated (9 errors): job_control.txt => job_control.html generated (0 errors): lsp-extension.txt => lsp-extension.html generated (214 errors): lsp.txt => lsp.html generated (311 errors): lua.txt => lua.html generated (592 errors): luaref.txt => luaref.html generated (798 errors): luvref.txt => luvref.html generated (663 errors): map.txt => map.html generated (228 errors): mbyte.txt => mbyte.html generated (228 errors): message.txt => message.html generated (0 errors): mlang.txt => mlang.html generated (761 errors): motion.txt => motion.html generated (4 errors): nvim.txt => nvim.html generated (226 errors): nvim_terminal_emulator.txt => nvim_terminal_emulator.html generated (988 errors): options.txt => options.html generated (567 errors): pattern.txt => pattern.html generated (15 errors): pi_gzip.txt => pi_gzip.html generated (10 errors): pi_health.txt => pi_health.html generated (27 errors): pi_msgpack.txt => pi_msgpack.html generated (2177 errors): pi_netrw.txt => pi_netrw.html generated (41 errors): pi_paren.txt => pi_paren.html generated (9 errors): pi_spec.txt => pi_spec.html generated (218 errors): pi_tar.txt => pi_tar.html generated (0 errors): pi_tutor.txt => pi_tutor.html generated (235 errors): pi_zip.txt => pi_zip.html generated (265 errors): print.txt => print.html generated (31 errors): provider.txt => provider.html generated (335 errors): quickfix.txt => quickfix.html generated (572 errors): quickref.txt => quickref.html generated (109 errors): recover.txt => recover.html generated (14 errors): remote.txt => remote.html generated (14 errors): remote_plugin.txt => remote_plugin.html generated (351 errors): repeat.txt => repeat.html generated (23 errors): rileft.txt => rileft.html generated (12 errors): russian.txt => russian.html generated (6 errors): scroll.txt => scroll.html generated (106 errors): sign.txt => sign.html generated (347 errors): spell.txt => spell.html generated (784 errors): starting.txt => starting.html generated (1499 errors): syntax.txt => syntax.html generated (23 errors): tabpage.txt => tabpage.html generated (257 errors): tagsrch.txt => tagsrch.html generated (31 errors): term.txt => term.html generated (0 errors): testing.txt => testing.html generated (96 errors): tips.txt => tips.html generated (57 errors): treesitter.txt => treesitter.html generated (71 errors): uganda.txt => uganda.html generated (74 errors): ui.txt => ui.html generated (87 errors): undo.txt => undo.html generated (17 errors): userfunc.txt => userfunc.html generated (1 errors): usr_01.txt => usr_01.html generated (89 errors): usr_02.txt => usr_02.html generated (293 errors): usr_03.txt => usr_03.html generated (46 errors): usr_04.txt => usr_04.html generated (96 errors): usr_05.txt => usr_05.html generated (54 errors): usr_06.txt => usr_06.html generated (20 errors): usr_07.txt => usr_07.html generated (241 errors): usr_08.txt => usr_08.html generated (130 errors): usr_09.txt => usr_09.html generated (50 errors): usr_10.txt => usr_10.html generated (33 errors): usr_11.txt => usr_11.html generated (32 errors): usr_12.txt => usr_12.html generated (22 errors): usr_20.txt => usr_20.html generated (75 errors): usr_21.txt => usr_21.html generated (8 errors): usr_22.txt => usr_22.html generated (3 errors): usr_23.txt => usr_23.html generated (163 errors): usr_25.txt => usr_25.html generated (13 errors): usr_26.txt => usr_26.html generated (84 errors): usr_27.txt => usr_27.html generated (173 errors): usr_28.txt => usr_28.html generated (285 errors): usr_29.txt => usr_29.html generated (280 errors): usr_30.txt => usr_30.html generated (11 errors): usr_31.txt => usr_31.html generated (13 errors): usr_32.txt => usr_32.html generated (156 errors): usr_40.txt => usr_40.html generated (134 errors): usr_41.txt => usr_41.html generated (35 errors): usr_42.txt => usr_42.html generated (19 errors): usr_43.txt => usr_43.html generated (60 errors): usr_44.txt => usr_44.html generated (13 errors): usr_45.txt => usr_45.html generated (1 errors): usr_toc.txt => usr_toc.html generated (69 errors): various.txt => various.html generated (68 errors): vi_diff.txt => vi_diff.html generated (437 errors): vim_diff.txt => vim_diff.html generated (296 errors): visual.txt => visual.html generated (181 errors): windows.txt => windows.html generated 119 html pages total errors: 23862 invalid tags: 537		2022-09-22 15:36:27 +02:00
.github	ci(publish-winget): fix errors that prevents release (#20232 )	2022-09-19 10:48:05 +02:00
ci	ci(build.ps1): restore comment removed in #19336	2022-08-15 12:41:00 +08:00
cmake	build: ensure version generation always succeeds (#19515 )	2022-09-10 14:37:11 +02:00
cmake.config	build: rename build-related dirs	2022-06-28 04:02:29 -07:00
cmake.deps	feat(treesitter): bundle :help parser and queries	2022-09-22 15:36:27 +02:00
cmake.packaging	build: rename build-related dirs	2022-06-28 04:02:29 -07:00
contrib	build(nix): removed the useless 'app'	2022-09-05 17:47:06 +02:00
runtime	feat(docs): gen_help_html.lua	2022-09-22 15:36:27 +02:00
scripts	feat(docs): gen_help_html.lua	2022-09-22 15:36:27 +02:00
snap	cmake: install app icon in XDG hicolor icon theme (#14656 )	2021-05-27 22:37:24 +02:00
src	fix(window): close floats first when closing buffer in other tab (#20284 )	2022-09-22 20:25:34 +08:00
test	feat(docs): gen_help_html.lua	2022-09-22 15:36:27 +02:00
.cirrus.yml	ci: move BSD jobs from sourcehut to Cirrus CI #19616	2022-09-08 15:12:42 -07: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
.flake8	ci: pylint target via flake8	2019-07-29 22:14:23 +02: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	vim-patch:8.1.0941: macros for MS-Windows are inconsistent (#20215 )	2022-09-18 09:17:15 +08: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	build: rename build-related dirs	2022-06-28 04:02:29 -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

README.md

Documentation | Chat | Twitter

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

Simplify maintenance and encourage contributions
Split the work between multiple developers
Enable advanced UIs without modifications to the core
Maximize extensibility

See the Introduction wiki page and Roadmap for more information.

Features

Modern GUIs
API access from any language including C/C++, C#, Clojure, D, Elixir, Go, Haskell, Java, JavaScript/Node.js, Julia, Lisp, Lua, Perl, Python, Racket, Ruby, Rust
Embedded, scriptable terminal emulator
Asynchronous job control
Shared data (shada) among multiple editor instances
XDG base directories support
Compatible with most Vim plugins, including Ruby and Python plugins

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.