diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2026-10-16 16:27:09 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2026-10-16 19:02:23 +0200 |
| commit | b83273aefdd9a8bec89210bc76bdd79bafba88f4 (patch) | |
| tree | 19d5a122256793019b7c2e2122da4246faefa656 /runtime/lua/vim | |
| parent | d65f9daf45f8ba1f9a92ab33d59301bff17f4039 (diff) | |
| download | rneovim-b83273aefdd9a8bec89210bc76bdd79bafba88f4.tar.gz rneovim-b83273aefdd9a8bec89210bc76bdd79bafba88f4.tar.bz2 rneovim-b83273aefdd9a8bec89210bc76bdd79bafba88f4.zip | |
docs: flow layout
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.
Diffstat (limited to 'runtime/lua/vim')
| -rw-r--r-- | runtime/lua/vim/_meta/options.gen.lua | 105 | ||||
| -rw-r--r-- | runtime/lua/vim/_meta/vimfn.gen.lua | 1 |
2 files changed, 59 insertions, 47 deletions
diff --git a/runtime/lua/vim/_meta/options.gen.lua b/runtime/lua/vim/_meta/options.gen.lua index 19214b18b5..bfec94d562 100644 --- a/runtime/lua/vim/_meta/options.gen.lua +++ b/runtime/lua/vim/_meta/options.gen.lua @@ -269,6 +269,7 @@ vim.go.bg = vim.go.background --- Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert --- mode. This is a list of items, separated by commas. Each item allows --- a way to backspace over something: +--- --- value effect ~ --- indent allow backspacing over autoindent --- eol allow backspacing over line breaks (join lines) @@ -486,31 +487,31 @@ vim.go.bsk = vim.go.backupskip --- mode to be silenced. --- You can also make it flash by using 'visualbell'. --- ---- item meaning when present ~ ---- all All events. ---- backspace When hitting <BS> or <Del> and deleting results in an ---- error. ---- cursor Fail to move around using the cursor keys or ---- <PageUp>/<PageDown> in `Insert-mode`. ---- complete Error occurred when using `i_CTRL-X_CTRL-K` or ---- `i_CTRL-X_CTRL-T`. ---- copy Cannot copy char from insert mode using `i_CTRL-Y` or ---- `i_CTRL-E`. ---- ctrlg Unknown Char after <C-G> in Insert mode. ---- error Other Error occurred (e.g. try to join last line) ---- (mostly used in `Normal-mode` or `Cmdline-mode`). ---- esc hitting <Esc> in `Normal-mode`. ---- hangul Ignored. ---- lang Calling the beep module for Lua/Mzscheme/TCL. ---- mess No output available for `g<`. ---- showmatch Error occurred for 'showmatch' function. ---- operator Empty region error `cpo-E`. ---- register Unknown register after <C-R> in `Insert-mode`. ---- shell Bell from shell output `:!`. ---- spell Error happened on spell suggest. ---- term Bell from `:terminal` output. ---- wildmode More matches in `cmdline-completion` available ---- (depends on the 'wildmode' setting). +--- item meaning when present ~ +--- all All events. +--- backspace When hitting <BS> or <Del> and deleting results in an +--- error. +--- cursor Fail to move around using the cursor keys or +--- <PageUp>/<PageDown> in `Insert-mode`. +--- complete Error occurred when using `i_CTRL-X_CTRL-K` or +--- `i_CTRL-X_CTRL-T`. +--- copy Cannot copy char from insert mode using `i_CTRL-Y` or +--- `i_CTRL-E`. +--- ctrlg Unknown Char after <C-G> in Insert mode. +--- error Other Error occurred (e.g. try to join last line) +--- (mostly used in `Normal-mode` or `Cmdline-mode`). +--- esc hitting <Esc> in `Normal-mode`. +--- hangul Ignored. +--- lang Calling the beep module for Lua/Mzscheme/TCL. +--- mess No output available for `g<`. +--- showmatch Error occurred for 'showmatch' function. +--- operator Empty region error `cpo-E`. +--- register Unknown register after <C-R> in `Insert-mode`. +--- shell Bell from shell output `:!`. +--- spell Error happened on spell suggest. +--- term Bell from `:terminal` output. +--- wildmode More matches in `cmdline-completion` available +--- (depends on the 'wildmode' setting). --- --- This is most useful to fine tune when in Insert mode the bell should --- be rung. For Normal mode and Ex commands, the bell is often rung to @@ -2611,6 +2612,7 @@ vim.bo.ft = vim.bo.filetype --- double-width characters are not supported. `E1512` --- --- The highlighting used for these items: +--- --- item highlight group ~ --- stl StatusLine `hl-StatusLine` --- stlnc StatusLineNC `hl-StatusLineNC` @@ -2876,6 +2878,7 @@ vim.wo.fdn = vim.wo.foldnestmax --- Also for `[s` and `]s`. --- tag jumping to a tag: ":ta", CTRL-T, etc. --- undo undo or redo: "u" and CTRL-R +--- --- When a movement command is used for an operator (e.g., "dl" or "y%") --- this option is not used. This means the operator will include the --- whole closed fold. @@ -5667,10 +5670,12 @@ vim.go.sect = vim.go.sections --- This option defines the behavior of the selection. It is only used --- in Visual and Select mode. --- Possible values: ---- value past line inclusive ~ +--- +--- value past line inclusive ~ --- old no yes --- inclusive yes yes --- exclusive yes no +--- --- "past line" means that the cursor is allowed to be positioned one --- character past the line. --- "inclusive" means that the last character of the selection is included @@ -5712,6 +5717,7 @@ vim.go.slm = vim.go.selectmode --- Changes the effect of the `:mksession` command. It is a comma- --- separated list of words. Each word enables saving and restoring --- something: +--- --- word save and restore ~ --- blank empty windows --- buffers hidden and unloaded buffers, not just those in windows @@ -5761,6 +5767,7 @@ vim.go.ssop = vim.go.sessionoptions --- character is left out, then the default value is used for that --- parameter. The following is a list of the identifying characters and --- the effect of their value. +--- --- CHAR VALUE ~ --- *shada-!* --- ! When included, save and restore global variables that start @@ -6139,44 +6146,45 @@ vim.bo.sw = vim.bo.shiftwidth --- messages. --- --- It is a list of flags: +--- --- flag meaning when present ~ ---- l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l* ---- m use "[+]" instead of "[Modified]" *shm-m* ---- r use "[RO]" instead of "[readonly]" *shm-r* ---- w use "[w]" instead of "written" for file write message *shm-w* +--- l use "999L, 888B" instead of "999 lines, 888 bytes" *shm-l* +--- m use "[+]" instead of "[Modified]" *shm-m* +--- r use "[RO]" instead of "[readonly]" *shm-r* +--- w use "[w]" instead of "written" for file write message *shm-w* --- and "[a]" instead of "appended" for ':w >> file' command ---- a all of the above abbreviations *shm-a* ---- ---- o overwrite message for writing a file with subsequent *shm-o* +--- a all of the above abbreviations *shm-a* +--- ---------------------------------------------------------------------- +--- o overwrite message for writing a file with subsequent *shm-o* --- message for reading a file (useful for ":wn" or when --- 'autowrite' on) ---- O message for reading a file overwrites any previous *shm-O* +--- O message for reading a file overwrites any previous *shm-O* --- message; also for quickfix message (e.g., ":cn") ---- s don't give "search hit BOTTOM, continuing at TOP" or *shm-s* +--- s don't give "search hit BOTTOM, continuing at TOP" or *shm-s* --- "search hit TOP, continuing at BOTTOM" messages; when using --- the search count do not show "W" before the count message --- (see `shm-S` below) ---- t truncate file message at the start if it is too long *shm-t* +--- t truncate file message at the start if it is too long *shm-t* --- to fit on the command-line, "<" will appear in the left most --- column; ignored in Ex mode ---- T truncate other messages in the middle if they are too *shm-T* +--- T truncate other messages in the middle if they are too *shm-T* --- long to fit on the command line; "..." will appear in the --- middle; ignored in Ex mode ---- W don't give "written" or "[w]" when writing a file *shm-W* ---- A don't give the "ATTENTION" message when an existing *shm-A* +--- W don't give "written" or "[w]" when writing a file *shm-W* +--- A don't give the "ATTENTION" message when an existing *shm-A* --- swap file is found ---- I don't give the intro message when starting Vim, *shm-I* +--- I don't give the intro message when starting Vim, *shm-I* --- see `:intro` ---- c don't give `ins-completion-menu` messages; for *shm-c* +--- c don't give `ins-completion-menu` messages; for *shm-c* --- example, "-- XXX completion (YYY)", "match 1 of 2", "The only --- match", "Pattern not found", "Back at original", etc. ---- C don't give messages while scanning for ins-completion *shm-C* +--- C don't give messages while scanning for ins-completion *shm-C* --- items, for instance "scanning tags" ---- q do not show "recording @a" when recording a macro *shm-q* ---- F don't give the file info when editing a file, like *shm-F* +--- q do not show "recording @a" when recording a macro *shm-q* +--- F don't give the file info when editing a file, like *shm-F* --- `:silent` was used for the command; note that this also --- affects messages from 'autoread' reloading ---- S do not show search count message when searching, e.g. *shm-S* +--- S do not show search count message when searching, e.g. *shm-S* --- "[1/5]". When the "S" flag is not present (e.g. search count --- is shown), the "search hit BOTTOM, continuing at TOP" and --- "search hit TOP, continuing at BOTTOM" messages are only @@ -6184,7 +6192,7 @@ vim.bo.sw = vim.bo.shiftwidth --- search count statistics. The maximum limit can be set with --- the 'maxsearchcount' option, see also `searchcount()` --- function. ---- u don't give undo and redo messages like *shm-u* +--- u don't give undo and redo messages like *shm-u* --- "1 line less; before #1 1 second ago", "Already at oldest --- change" or "Already at newest change" --- @@ -7922,6 +7930,7 @@ vim.go.vdir = vim.go.viewdir --- Changes the effect of the `:mkview` command. It is a comma-separated --- list of words. Each word enables saving and restoring something: +--- --- word save and restore ~ --- cursor cursor position in file and in window --- curdir local current directory, if set with `:lcd` @@ -7930,7 +7939,7 @@ vim.go.vdir = vim.go.viewdir --- options options and mappings local to a window or buffer (not --- global values for local options), except Lua functions --- `option-value-function`. ---- localoptions same as "options" +--- localoptions same as "options" --- slash `deprecated` Always enabled. Uses "/" in filenames. --- unix `deprecated` Always enabled. Uses "\n" line endings. --- @@ -7993,6 +8002,7 @@ vim.go.warn = vim.o.warn --- Allow specified keys that move the cursor left/right to move to the --- previous/next line when the cursor is on the first/last character in --- the line. Concatenate characters to allow this for these keys: +--- --- char key mode ~ --- b <BS> Normal and Visual --- s <Space> Normal and Visual @@ -8003,6 +8013,7 @@ vim.go.warn = vim.o.warn --- ~ "~" Normal --- [ <Left> Insert and Replace --- ] <Right> Insert and Replace +--- --- For example: --- --- ```vim diff --git a/runtime/lua/vim/_meta/vimfn.gen.lua b/runtime/lua/vim/_meta/vimfn.gen.lua index 2831a1d5ee..589140169e 100644 --- a/runtime/lua/vim/_meta/vimfn.gen.lua +++ b/runtime/lua/vim/_meta/vimfn.gen.lua @@ -8114,6 +8114,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end --- call searchcount() --- < --- {options} must be a |Dictionary|. It can contain: +--- --- key type meaning ~ --- recompute |Boolean| if |TRUE|, recompute the count --- like |n| or |N| was executed. |