aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/help.txt
Commit message (Collapse)AuthorAge
* docs: flow layoutJustin M. Keyes4 days
| | | | | | | | | | Work towards enabling "flow" layout in most `:help` files. Since [tables are supported in help](https://github.com/neovim/tree-sitter-vimdoc#tables), it's now possible to render most help files as ["flow" layout](https://github.com/neovim/neovim/blob/9244da12e400ec0291450a5e9400d995e7a29b83/src/gen/gen_help_html.lua#L86-L88) instead of the legacy fixed-width layout. Besides [improved HTML rendering](https://github.com/neovim/neovim/pull/42381#discussion_r4285705739), flow layout will allow `:help` presentation-mode to un-hardwrap text blocks.
* feat(multicursor): MC HAMMER #41587Justin M. Keyes2026-09-01
| | | | | | | | | | | | | | | | | | | | | Other (squashed) commits: fix(tui): emit ui_send output atomically with the frame Problem: tui_ui_send() writes directly to the TTY, bypassing the output buffer. Sequences sent via nvim_ui_send() (e.g. kitty multiple-cursors, or visual-dot-repeat) always arrive in a separate TTY write from the frame they were computed for. This manifests as "tearing", or e.g. in the case of multicursor the terminal renders text with stale cursor overlays. Solution: - tui_ui_send(): while a frame is being assembled (pending invalid regions or buffered output), buffer instead of writing directly. - Out-of-frame sends (tty queries, clear-on-disable) still write immediately. - mcursor.lua: emit the terminal-cursor update at the end of the redraw cycle (`on_end`, when screen positions are final) instead of vim.schedule().
* docs: misc #39045Justin M. Keyes2026-04-18
|
* refactor(help): move local-additions to Lua #37831Yochem van Rosmalen2026-02-14
| | | | | | | | | | | Problem: - ~200 line function of hard-to-maintain C code. - Local Addition section looks messy because of the varying description formats. Solution: - Move code to Lua. - Have a best-effort approach where short descriptions are right aligned, giving a cleaner look. Long descriptions are untouched.
* docs: misc (#37280)zeertzjq2026-01-07
| | | | | | | | | | | | | | | | | | | | Close #36806 Close #36812 Close #37003 Close #37016 Close #37038 Close #37039 Close #37157 Close #37185 Close #37213 Co-authored-by: saroj_r <sarojregmi.official@gmail.com> Co-authored-by: Olivia Kinnear <git@superatomic.dev> Co-authored-by: Igor <igorlfs@ufmg.br> Co-authored-by: Justin Roberts <JustinEdwardLeo@gmail.com> Co-authored-by: "Mike J. McGuirk" <mike.j.mcguirk@gmail.com> Co-authored-by: Aymen Hafeez <49293546+aymenhafeez@users.noreply.github.com> Co-authored-by: Peter Cardenas <16930781+PeterCardenas@users.noreply.github.com> Co-authored-by: DrNayak2306 <dhruvgnk.work@gmail.com>
* docs: rework main help pageJustin M. Keyes2025-11-16
|
* vim-patch:9.1.1893: ICCF charity will dissolve (#36427)zeertzjq2025-11-02
| | | | | | | | | | | | | | | | | Problem: ICCF charity will dissolve Solution: Update references to Kuwasha Since the ICCF[1] will be dissolved and handing over to the Kuwasha charity to continue supporting the Kibaale Children Center in Uganda, update the uganda.txt help file. [1]: https://groups.google.com/g/vim_announce/c/pUNbNXBLbKw/m/-zFUd4JjAQAJ fixes: vim/vim#18584 closes: vim/vim#18667 https://github.com/vim/vim/commit/0405665638052ca1180bdb2855237cd1868526a3 Co-authored-by: Christian Brabandt <cb@256bit.org>
* docs: rename l10n help files #36377Justin M. Keyes2025-10-28
|
* docs: plugins.txt #35680altermo2025-09-10
| | | Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
* docs: lsp, ui events, dev guidance, osc7Justin M. Keyes2025-07-28
| | | | fix #34981
* fix(build): vimdoc tags are not validated #32801Justin M. Keyes2025-03-09
| | | | | | | | | Problem: "make lintdoc" is not validating vimdoc (:help) tags. Solution: - Call `lang_tree:parse()` to init the parser. - Load netrw 🤢 explicitly, since it was moved to `pack/dist/opt/`. - Fix invalid help tags.
* vim-patch:41afa30: runtime(doc): Add vietnamese.txt to helps main TOCzeertzjq2024-12-08
| | | | | | | | closes: vim/vim#16177 https://github.com/vim/vim/commit/41afa308d6f420504c47567b494e97a6721afe71 Co-authored-by: h-east <h.east.727@gmail.com>
* docs: dev-arch, focusable windows #30510Justin M. Keyes2024-10-07
| | | | - 'statuscolumn' is no longer experimental - add tags for popular searches on neovim.io
* feat(help): use treesitter for table of contentsChristian Clason2024-06-09
| | | | | | Problem: Creating the table of contents for `gO` is complicated. Solution: Use treesitter instead.
* vim-patch:0bdc5d8: runtime(doc): Add ft_hare.txt to Reference Manual TOC ↵zeertzjq2024-06-01
| | | | | | | | | | | | (#29120) while at it, also re-align ft_context.txt with the rest of the list. closes: vim/vim#14863 https://github.com/vim/vim/commit/0bdc5d8241335c3451f629eed7a3734021d41679 Co-authored-by: h-east <h.east.727@gmail.com>
* docs: extract health to its own filedundargoc2024-05-24
|
* docs: move vim.health documentation to lua.txtdundargoc2024-05-22
| | | | | | `vim.health` is not a "plugin" but part of our Lua API and the documentation should reflect that. This also helps make the documentation maintenance easier as it is now generated.
* docs: move vim-patch wiki page to runtime documentationdundargoc2023-12-13
|
* docs: add wiki FAQ to the runtime documentation (#26539)dundargoc2023-12-13
| | | | | | Problem: Wiki contents are not discoverable and hard to maintain. Solution: Move FAQ to runtime docs. Co-authored-by: Christian Clason <c.clason@uni-graz.at>
* docs: small fixes (#25831)dundargoc2023-11-03
| | | Co-authored-by: Peter Aronoff <peter@aronoff.org>
* test: spellcheck :help (vimdoc) files #24109Justin M. Keyes2023-06-22
| | | | | | | Enforce consistent terminology (defined in `gen_help_html.lua:spell_dict`) for common misspellings. This does not spellcheck English in general (perhaps a future TODO, though it may be noisy).
* feat(lua): rename vim.loop -> vim.uv (#22846)Lewis Russell2023-06-03
|
* docs(help): consistent headers for local additionsChristian Clason2023-03-13
|
* docs: fix typos (#22353)zeertzjq2023-02-22
|
* feat!: remove hardcopyLewis Russell2023-01-03
| | | Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
* docs(lua): add guide to using Lua in Neovim (#21137)dundargoc2022-12-08
| | | | | | | | Add introductory guide explaining how to use Lua in Neovim: where to put Lua files, how to set variables and options, how to create mappings, autocommands, and user commands. Adapted with kind permission from https://github.com/nanotee/nvim-lua-guide
* docs: update vimdoc parser #20747Justin M. Keyes2022-10-20
| | | | | | | | | Remove the user-manual ToC from help.txt, because: 1. it duplicates usr_toc.txt 2. it is not what most readers are looking for in the main help page. fix https://github.com/neovim/tree-sitter-vimdoc/issues/49 fix https://github.com/neovim/tree-sitter-vimdoc/issues/50 fix https://github.com/neovim/tree-sitter-vimdoc/issues/51
* docs: "supported platforms" matrix #19615dundargoc2022-10-16
| | | | | | Inspired by libuv's own SUPPORTED_PLATFORMS.md: https://github.com/libuv/libuv/blob/v1.x/ https://neovim.io/doc/user/support.html
* feat(cscope)!: removeLewis Russell2022-10-13
|
* fix(docs): invalid :help links #20345Justin M. Keyes2022-09-25
| | | | | Fix those naughty single quotes. closes #20159
* vim-patch:partial 0daafaa7d99e (#20083)Christian Clason2022-09-06
| | | | | | | Update runtime files https://github.com/vim/vim/commit/0daafaa7d99ef500f76b1b12f5fe8153e2fcaea0 skip vim9script ftplugin create userfunc.txt from Neovim content (skip section 3, needs 9.0.0379)
* docs(lua): add luv (`vim.loop`) reference manual (#19679)Christian Clason2022-08-09
| | | | Upstreamed from https://github.com/nanotee/luv-vimdocs with kind permission from @nanotee.
* vim-patch:partial: 48c3f4e0bff7 (#19684)Christian Clason2022-08-09
| | | | | | | | vim-patch:partial:48c3f4e0bff7 Update runtime files https://github.com/vim/vim/commit/48c3f4e0bff7efd289a7001b68c777b6f89a7057 partially skip `options.txt` (needs 9.0.0138)
* docs(lua): add Lua 5.1 reference manual (#19663)dundargoc2022-08-08
| | | | | | | | based on http://www.vim.org/scripts/script.php?script_id=1291 reformatted to match Nvim documentation style; removed irrelevant sections Co-authored-by: dundargoc <gocundar@gmail.com> Co-authored-by: Christian Clason <c.clason@uni-graz.at> Co-authored-by: Lewis Russell <lewis6991@gmail.com>
* vim-patch:8.2.3917: the eval.txt help file is way too bigDaniel Steinberg2022-01-29
| | | | | | | | | | | | Problem: The eval.txt help file is way too big. Solution: Move the builtin function details to a separate file. https://github.com/vim/vim/commit/1cae5a0a034d0545360387407a7a409310f1efe2 Note: Neovim-specific references to |functions| were changed to |builtin-functions|. This included updates to: 1. test/functional/vimscript/functions_spec.lua 2. test/functional/vimscript/eval_spec.lua 3. runtime/doc/lua.txt
* docs: update missing help sections from main help page (#16573)dundargoc2021-12-08
| | | Also replace non-existent help section remote.txt to remote_plugins.txt
* vim-patch:partial 2346a6378483 (#15599)Christian Clason2021-09-09
| | | | | | | | | | | | Update runtime files https://github.com/vim/vim/commit/2346a6378483c9871016f9fc821ec5cbea638f13 omit doc/vim.man omit doc/vim9.txt omit doc/vimdiff.txt omit doc/vimdiff.man skip doc/eval.txt (missing patch 8.2.2324) skip doc/help.txt (missing patch 8.2.2344)
* docs(help.txt): add treesitter to the main help fileJavier Lopez2021-08-09
|
* docs(help.txt): add a tag to the neovim apiJavier Lopez2021-08-09
|
* vim-patch:207f009326c8Jan Edmund Lazo2021-04-29
| | | | | | | Update runtime files. https://github.com/vim/vim/commit/207f009326c8f878defde0e594d7d9ed9860106e Omit nl.po.
* vim-patch:d1caa941d876Jan Edmund Lazo2021-04-27
| | | | | | | Update runtime files https://github.com/vim/vim/commit/d1caa941d876181aae0ebebc6ea954045bf0da24 Cherry-pick error E452 from patch v8.2.0486.
* vim-patch:8.1.1726: the eval.txt help file is too bigJan Edmund Lazo2021-04-27
| | | | | | | | | | Problem: The eval.txt help file is too big. Solution: Split off testing support to testing.txt. Move function details to where the functionality is explained. https://github.com/vim/vim/commit/ed997adaa1e9bd057ce732a73d933b739e9d0c30 Vim commit 5477506a9f01d40fad2e8f0555bc37adee30478f contains the duplicate tag fix in runtime/doc/testing.txt.
* docs: Align help docs to match using tab (#12891)Dave Lage2020-09-12
|
* docs, remove 'guifontset' #11708Justin M. Keyes2020-08-31
| | | | | | | | | | | | | - remove redundant autocmd list This "grouped" list is useless, it only gets in the way when searching for event names. - intro.txt: cleanup - starting.txt: update, revisit - doc: `:help bisect` - mbyte.txt: update aliases 1656367b90bd. closes #11960 - options: remove 'guifontset'. Why: - It is complicated and is used by almost no one. - It is unlikely to be implemented by Nvim GUIs (complicated to parse, specific to Xorg...).
* doc [ci skip] #11656Justin M. Keyes2020-01-12
|
* doc: Lua [ci skip] #11378Justin M. Keyes2019-11-17
| | | | - Rework :help lua-commands - Rename if_lua.txt => lua.txt
* doc: |api-fast| [ci skip]Justin M. Keyes2019-09-09
|
* vim-patch:4c05fa08c973Justin M. Keyes2019-07-29
| | | | | Update runtime files https://github.com/vim/vim/commit/4c05fa08c9739e307ddc88ac91ba6d208f1fd68e
* vim-patch:9d87a37ee9d8Justin M. Keyes2019-07-29
| | | | | Update runtime files. https://github.com/vim/vim/commit/9d87a37ee9d87f5bdbc779bc940d5f1e6f055d0a
* vim-patch:8.1.0932: remove Farsi support (#9622)Justin M. Keyes2019-02-17
| | | | | Problem: Farsi support is outdated and unused. Solution: Delete the Farsi support. https://github.com/vim/vim/commit/14184a3133b9a6ee5f711d493c04e41ba4fa7c2f