mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-09-02 04:13:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b36b3d7f3a07cfcc4e76079188bfd7d3976a9cd3
neovim/runtime/doc
History
Yochem van Rosmalen b36b3d7f3a feat(help): generate :helptags using Treesitter 
Problem:
Tags are manually parsed in C which is not flexible and prone to errors.
Extending the help system to allow for other formats (e.g. Markdown)
would require a large rewrite in the C core, while with Treesitter it
only needs a query update.

Solution:
Use the power of treesitter to extract the tags from helpfiles.

- build: set `$VIMRUNTIME` when generating helptags, like
  `cmake/Util.cmake` already does for other generators.
- fix(help): only accept tags delimited by whitespace. The old C parser
  only accepted a `*tag*` preceded by start-of-line or whitespace and
  followed by whitespace or end-of-line. The vimdoc parser also captures
  tags followed by other text, e.g. `*$XDG_STATE_HOME*/.../logs` in
  starting.txt, which caused an E154 duplicate tag error for docs that
  were previously fine.
2026-08-25 10:52:12 +02:00
..
api-ui-events.txt
fix(cmdline): encode no prompt in cmdline_show.hl_id
2026-06-22 15:56:26 +02:00
api.txt
docs: misc #41452
2026-08-23 12:38:07 -04:00
autocmd.txt
fix(cmdatom): terminal-mode keys leak into mapping lhs #41455
2026-08-23 15:04:11 -04:00
change.txt
vim-patch:ef461d1: runtime(doc): fix typo in :h substitute-repeat
2026-08-24 08:15:10 +08:00
channel.txt
feat(prompt): support 'scrollback' option in prompt-buffers #39793
2026-05-16 10:14:18 -04:00
cmdline.txt
docs: misc #41452
2026-08-23 12:38:07 -04:00
credits.txt
vim-patch:9.1.1933: completion: complete_match() is not useful (#36726)
2025-11-28 10:10:31 +08:00
deprecated.txt
docs: misc, remove some old help tags #40214
2026-07-18 04:29:51 -04:00
dev_arch.txt
feat(cmdatom): mappings capture continuation
2026-08-22 17:29:34 +02:00
dev_style.txt
docs: lsp, options, promptbuf
2026-02-12 13:46:45 +01:00
dev_test.txt
test: run Lua harness with nvim -l
2026-05-13 13:14:07 +01:00
dev_theme.txt
docs: news
2024-05-15 23:19:26 +02:00
dev_tools.txt
refactor(insert): rename edit.c => insert.c #40705
2026-07-12 11:57:17 -04:00
dev_vimpatch.txt
docs: misc, remove some old help tags #40214
2026-07-18 04:29:51 -04:00
dev.txt
refactor: cleanup, docs #40480
2026-06-29 13:10:31 -04:00
diagnostic.txt
docs(api): buffer columns are byte indices #41137
2026-08-04 05:19:54 -04:00
diff.txt
docs: func/expr options, misc #41102
2026-08-01 17:48:32 -04:00
digraph.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
editing.txt
vim-patch:e402d1c: runtime(doc): improve documentation for |v_gF| (#41300)
2026-08-14 07:46:52 +08:00
faq.txt
fix(ux): drop "Sorry" from messages #38318
2026-03-16 07:46:34 -04:00
filetype.txt
vim-patch:9.2.0926: filetype: Business Central files are not recognized (#41230)
2026-08-09 00:49:20 +00:00
fold.txt
docs: func/expr options, misc #41102
2026-08-01 17:48:32 -04:00
ft_ada.txt
docs: misc
2025-12-06 20:33:02 -05:00
ft_hare.txt
docs: treesitter parse errors #33811
2025-05-03 10:08:53 -07:00
ft_ps1.txt
docs: treesitter parse errors #33811
2025-05-03 10:08:53 -07:00
ft_raku.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
ft_rust.txt
vim-patch:880cf88: runtime(doc): Various fixes for ft_rust.txt (tw78, grammar, spaces) (#38730)
2026-04-03 21:38:44 +08:00
ft_sql.txt
docs: drop "xx.vim" syntax help-tags #35623
2025-09-07 20:45:22 -07:00
gui.txt
feat(detach): opt-in to "server keeps running" #41133
2026-08-04 06:20:16 -04:00
health.txt
docs(health): avoid warnings for dynamic filetypes #41036
2026-07-29 09:03:53 -04:00
help.txt
docs: misc #39045
2026-04-18 15:38:59 -04:00
helphelp.txt
feat(help): super K (":help!") guesses tag at cursor #36205
2026-03-15 19:02:49 -04:00
if_perl.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
if_pyth.txt
refactor(exmode): Ex-mode as cmdwin + Lua #40991
2026-07-27 06:25:21 -04:00
if_ruby.txt
docs: misc #37357
2026-01-27 17:14:57 -05:00
indent.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
index.txt
fix(cwd): validate getcwd(…, -1)
2026-08-04 20:48:44 +02:00
insert.txt
vim-patch:9.2.1001: complete_info() does not report the item highlight groups (#41461)
2026-08-24 14:35:25 +08:00
intro.txt
docs: misc, cwd, vimscript.txt #41356
2026-08-17 13:37:08 -04:00
job_control.txt
test: lint EXX error codes #8155
2026-04-16 10:48:11 -04:00
l10n-arabic.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
l10n-hebrew.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
l10n-russian.txt
vim-patch:17bba75: runtime(doc): Fix overlength lines in :help {russian,vietnamese}.txt
2026-01-26 07:05:42 +08:00
l10n-vietnamese.txt
vim-patch:17bba75: runtime(doc): Fix overlength lines in :help {russian,vietnamese}.txt
2026-01-26 07:05:42 +08:00
lsp.txt
feat(lsp): pass target buffer to reuse_client predicate #41163
2026-08-07 11:27:19 -04:00
lua-bit.txt
docs: change lua-bit to new layout #38447
2026-03-23 17:41:48 -04:00
lua-guide.txt
refactor(api): omit optional param
2026-07-13 19:44:15 +02:00
lua-plugin.txt
docs: bufadd(), fnameescape() guidance #40378
2026-06-23 10:08:50 -04:00
lua.txt
feat(ui2): lift ui2 options into 'messagesopt' (part 1) #41474
2026-08-25 03:58:17 -04:00
luaref.txt
feat(docs): numbered listitems
2025-12-15 13:55:15 -05:00
luvref.txt
build(deps): bump luv to 1.52.1-0
2026-03-16 10:29:58 +01:00
map.txt
fix(api): add lhs option for keymap deletion
2026-07-25 10:36:56 -07:00
mbyte.txt
vim-patch:8.2.2440: documentation based on patches is outdated (#39144)
2026-04-17 09:50:03 +08:00
message.txt
fix(messages): dangling progress-messages #41222
2026-08-07 16:10:02 -04:00
mlang.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
motion.txt
docs: func/expr options, misc #41102
2026-08-01 17:48:32 -04:00
news-0.9.txt
docs: json, tests, lsp #35754
2025-09-28 20:57:59 -07:00
news-0.10.txt
docs: misc, :bcd, slug()
2026-08-06 10:27:29 +02:00
news-0.11.txt
docs: rename "tabpage"
2026-05-07 10:36:55 +02:00
news-0.12.txt
docs: misc, remove some old help tags #40214
2026-07-18 04:29:51 -04:00
news.txt
feat(help): generate :helptags using Treesitter
2026-08-25 10:52:12 +02:00
nvim.txt
docs: dev, lsp, indent-guides #39756
2026-05-14 13:13:30 -04:00
options.txt
feat(ui2): lift ui2 options into 'messagesopt' (part 1) #41474
2026-08-25 03:58:17 -04:00
pack.txt
feat(pack): add support for sourcing manifest scripts
2026-07-31 19:20:34 +03:00
pattern.txt
fix(lua): vim.wait(0) does not call loop_poll #39679
2026-05-10 14:22:31 -04:00
pi_gzip.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
pi_msgpack.txt
feat(docs): numbered listitems
2025-12-15 13:55:15 -05:00
pi_paren.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
pi_spec.txt
docs: fix treesitter parsing errors
2023-01-01 15:05:13 +01:00
pi_tar.txt
vim-patch:e6a84bb: runtime(tar): missing g:tar_secure in tar#Extract() (#39123)
2026-04-16 22:19:48 +08:00
pi_tutor.txt
vim-patch:5a8f995: runtime(doc): remove outdated Contribution section in pi_tutor (#34094)
2025-05-20 00:21:30 +00:00
plugins.txt
docs: misc #41452
2026-08-23 12:38:07 -04:00
provider.txt
docs: setting g:clipboard after provider init #37705
2026-02-04 13:53:08 -05:00
quickfix.txt
vim-patch:9.2.0547: "%v" in 'errorformat' is affected by 'tabstop' (#40040)
2026-05-29 09:35:37 +08:00
quickref.txt
feat(exmode): "1q:", :exmode #41010
2026-07-27 11:12:47 -04:00
recover.txt
vim-patch:9.2.0486: out-of-bound read when recovering swap files (#39807)
2026-05-16 08:07:22 +08:00
remote_plugin.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
remote.txt
docs: misc, custom text-object #39877
2026-05-20 05:21:27 -04:00
repeat.txt
fix(cmdatom): "!" operator hardcodes its range #41451
2026-08-23 13:58:45 -04:00
rileft.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
scroll.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
sign.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
spell.txt
vim-patch:e2d3e78: runtime(doc): remove incorrect note about spellcapcheck and the first word
2026-07-26 09:00:30 +08:00
starting.txt
refactor(options): memory management
2026-07-31 21:50:04 +02:00
support.txt
ci: drop cirrus #39321
2026-04-22 18:25:07 -04:00
syntax.txt
vim-patch:5d41506: runtime(sh): Selectively suppress matching syntax errors (#41302)
2026-08-14 08:47:30 +08:00
tabpage.txt
docs: misc #39817
2026-05-17 10:02:12 -04:00
tagsrch.txt
docs: func/expr options, misc #41102
2026-08-01 17:48:32 -04:00
terminal.txt
docs: misc, :bcd, slug()
2026-08-06 10:27:29 +02:00
tips.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
treesitter.txt
docs: func/expr options, misc #41102
2026-08-01 17:48:32 -04:00
tui.txt
docs(tui): kitty keyboard protocol flags #41056
2026-07-30 05:50:39 -04:00
uganda.txt
vim-patch:19a5020: runtime(doc): Fix paypal link
2026-06-08 11:43:52 +08:00
undo.txt
docs: api, plugins, ui2
2026-03-24 00:14:55 +01:00
userfunc.txt
vim-patch:8.2.2440: documentation based on patches is outdated (#39144)
2026-04-17 09:50:03 +08:00
usr_01.txt
docs: misc, rename "tabpage"
2026-05-07 10:36:48 +02:00
usr_02.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_03.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_04.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_05.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_06.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_07.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_08.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_09.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_10.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_11.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_12.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_20.txt
vim-patch:partial:9.2.0573: Vim9: missing EX_WHOLE on some block keywords (#40071)
2026-06-01 01:04:30 +00:00
usr_21.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_22.txt
feat(dir.lua): global "-" default mapping #40426
2026-06-26 06:17:00 -04:00
usr_23.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_24.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_25.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_26.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_27.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_28.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_29.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_30.txt
vim-patch:ecba601: runtime(doc): fix a few small problems (#39969)
2026-05-24 00:10:36 +00:00
usr_31.txt
docs: misc #40847
2026-07-25 12:47:51 -04:00
usr_32.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_40.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_41.txt
refactor(vimscript)!: drop ctxget(), ctxpush(), etc #40724
2026-07-13 17:57:13 -04:00
usr_42.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_43.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_44.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_45.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_toc.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
various.txt
refactor(exmode): Ex-mode as cmdwin + Lua #40991
2026-07-27 06:25:21 -04:00
vi_diff.txt
docs: misc, :bcd, slug()
2026-08-06 10:27:29 +02:00
vim_diff.txt
fix(marks): undo reverts a mark set after the change #41330
2026-08-15 13:34:51 -04:00
vimeval.txt
docs: misc, cwd, vimscript.txt #41356
2026-08-17 13:37:08 -04:00
vimfn.txt
vim-patch:9.2.1001: complete_info() does not report the item highlight groups (#41461)
2026-08-24 14:35:25 +08:00
vimscript.txt
docs: misc, cwd, vimscript.txt #41356
2026-08-17 13:37:08 -04:00
visual.txt
feat(input)!: CmdAtom event #41297
2026-08-14 09:30:31 -04:00
vvars.txt
docs: misc, remove some old help tags #40214
2026-07-18 04:29:51 -04:00
windows.txt
docs: misc #41063
2026-07-30 15:09:19 -04:00
zip.txt
refactor(zip)!: address entries with zip:// paths
2026-08-03 15:22:25 -05:00