mirror of
https://github.com/neovim/neovim.git
synced 2025-09-30 06:58:35 +00:00
docs: plugins.txt #35680
Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
This commit is contained in:
@@ -176,14 +176,8 @@ DEVELOPING NVIM
|
|||||||
|dev-vimpatch| Merging patches from Vim
|
|dev-vimpatch| Merging patches from Vim
|
||||||
|
|
||||||
Standard plugins ~
|
Standard plugins ~
|
||||||
*standard-plugin-list*
|
|
||||||
|pi_gzip.txt| Reading and writing compressed files
|
See |standard-plugin-list|.
|
||||||
|pi_msgpack.txt| msgpack utilities
|
|
||||||
|pi_paren.txt| Highlight matching parens
|
|
||||||
|pi_spec.txt| Filetype plugin to work with rpm spec files
|
|
||||||
|pi_tar.txt| Tar file explorer
|
|
||||||
|pi_zip.txt| Zip archive explorer
|
|
||||||
|netrw| Reading and writing files over a network
|
|
||||||
|
|
||||||
Local additions ~
|
Local additions ~
|
||||||
*local-additions*
|
*local-additions*
|
||||||
|
@@ -5139,39 +5139,6 @@ vim.version.range({spec}) *vim.version.range()*
|
|||||||
(`vim.VersionRange?`) See |vim.VersionRange|.
|
(`vim.VersionRange?`) See |vim.VersionRange|.
|
||||||
|
|
||||||
|
|
||||||
==============================================================================
|
|
||||||
Lua module: tohtml *vim.tohtml*
|
|
||||||
|
|
||||||
|
|
||||||
:[range]TOhtml {file} *:TOhtml*
|
|
||||||
Converts the buffer shown in the current window to HTML, opens the generated
|
|
||||||
HTML in a new split window, and saves its contents to {file}. If {file} is not
|
|
||||||
given, a temporary file (created by |tempname()|) is used.
|
|
||||||
|
|
||||||
|
|
||||||
tohtml.tohtml({winid}, {opt}) *tohtml.tohtml.tohtml()*
|
|
||||||
Converts the buffer shown in the window {winid} to HTML and returns the
|
|
||||||
output as a list of string.
|
|
||||||
|
|
||||||
Parameters: ~
|
|
||||||
• {winid} (`integer?`) Window to convert (defaults to current window)
|
|
||||||
• {opt} (`table?`) Optional parameters.
|
|
||||||
• {title}? (`string|false`, default: buffer name) Title tag
|
|
||||||
to set in the generated HTML code.
|
|
||||||
• {number_lines}? (`boolean`, default: `false`) Show line
|
|
||||||
numbers.
|
|
||||||
• {font}? (`string[]|string`, default: `guifont`) Fonts to
|
|
||||||
use.
|
|
||||||
• {width}? (`integer`, default: 'textwidth' if non-zero or
|
|
||||||
window width otherwise) Width used for items which are
|
|
||||||
either right aligned or repeat a character infinitely.
|
|
||||||
• {range}? (`integer[]`, default: entire buffer) Range of
|
|
||||||
rows to use.
|
|
||||||
|
|
||||||
Return: ~
|
|
||||||
(`string[]`)
|
|
||||||
|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
Lua module: vim._extui *vim._extui*
|
Lua module: vim._extui *vim._extui*
|
||||||
|
|
||||||
|
73
runtime/doc/plugins.txt
Normal file
73
runtime/doc/plugins.txt
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
*plugins.txt* Nvim
|
||||||
|
|
||||||
|
|
||||||
|
NVIM REFERENCE MANUAL
|
||||||
|
|
||||||
|
Type |gO| to see the table of contents.
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
Plugins and modules included with Nvim
|
||||||
|
|
||||||
|
Nvim includes various Lua and Vim plugins or modules which may provide
|
||||||
|
commands (such as :TOhtml) or modules that you can optionally require() or
|
||||||
|
:packadd. The Lua ones are not part of the |lua-stdlib|, that is, they are not
|
||||||
|
available from the global `vim` module namespace. Some of the plugins are by
|
||||||
|
default loaded while others require a |:packadd| to be loaded.
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
Standard plugins ~
|
||||||
|
*standard-plugin-list*
|
||||||
|
Help-link Loaded Short description
|
||||||
|
|package-cfilter| No Filtering quickfix/location list
|
||||||
|
|package-justify| No Justify text
|
||||||
|
|package-nohlsearch| No Automatically run :nohlsearch
|
||||||
|
|package-termdebug| No Debug inside Nvim with gdb
|
||||||
|
|matchit| Yes Extended |%| matching
|
||||||
|
|editorconfig.txt| Yes Detect and internet editorconfig
|
||||||
|
|spellfile.vim| Yes Install spellfile if missing
|
||||||
|
|pi_tutor.txt| Yes Interactive tutorial
|
||||||
|
|pi_gzip.txt| Yes Reading and writing compressed files
|
||||||
|
|pi_msgpack.txt| No msgpack utilities
|
||||||
|
|pi_paren.txt| Yes Highlight matching parens
|
||||||
|
|pi_tar.txt| Yes Tar file explorer
|
||||||
|
|pi_zip.txt| Yes Zip archive explorer
|
||||||
|
|netrw| Yes Reading and writing files over a network
|
||||||
|
|ftplugin-docs| * Filetype specific plugins
|
||||||
|
|man.lua| Yes Opening and viewing manpages
|
||||||
|
|pi_spec.txt| Yes Filetype plugin to work with rpm spec files
|
||||||
|
|tohtml| Yes Convert buffer to html, syntax included
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
Builtin plugin: tohtml *tohtml*
|
||||||
|
|
||||||
|
|
||||||
|
:[range]TOhtml {file} *:TOhtml*
|
||||||
|
Converts the buffer shown in the current window to HTML, opens the generated
|
||||||
|
HTML in a new split window, and saves its contents to {file}. If {file} is not
|
||||||
|
given, a temporary file (created by |tempname()|) is used.
|
||||||
|
|
||||||
|
|
||||||
|
tohtml({winid}, {opt}) *tohtml.tohtml()*
|
||||||
|
Converts the buffer shown in the window {winid} to HTML and returns the
|
||||||
|
output as a list of string.
|
||||||
|
|
||||||
|
Parameters: ~
|
||||||
|
• {winid} (`integer?`) Window to convert (defaults to current window)
|
||||||
|
• {opt} (`table?`) Optional parameters.
|
||||||
|
• {title}? (`string|false`, default: buffer name) Title tag
|
||||||
|
to set in the generated HTML code.
|
||||||
|
• {number_lines}? (`boolean`, default: `false`) Show line
|
||||||
|
numbers.
|
||||||
|
• {font}? (`string[]|string`, default: `guifont`) Fonts to
|
||||||
|
use.
|
||||||
|
• {width}? (`integer`, default: 'textwidth' if non-zero or
|
||||||
|
window width otherwise) Width used for items which are
|
||||||
|
either right aligned or repeat a character infinitely.
|
||||||
|
• {range}? (`integer[]`, default: entire buffer) Range of
|
||||||
|
rows to use.
|
||||||
|
|
||||||
|
Return: ~
|
||||||
|
(`string[]`)
|
||||||
|
|
||||||
|
|
||||||
|
vim:tw=78:ts=8:sw=4:sts=4:et:ft=help:norl:
|
@@ -184,11 +184,9 @@ local config = {
|
|||||||
'version.lua',
|
'version.lua',
|
||||||
|
|
||||||
-- Sections at the end, in a specific order:
|
-- Sections at the end, in a specific order:
|
||||||
'tohtml.lua',
|
|
||||||
'_extui.lua',
|
'_extui.lua',
|
||||||
},
|
},
|
||||||
files = {
|
files = {
|
||||||
'runtime/lua/tohtml.lua',
|
|
||||||
'runtime/lua/vim/_editor.lua',
|
'runtime/lua/vim/_editor.lua',
|
||||||
'runtime/lua/vim/_extui.lua',
|
'runtime/lua/vim/_extui.lua',
|
||||||
'runtime/lua/vim/_inspector.lua',
|
'runtime/lua/vim/_inspector.lua',
|
||||||
@@ -249,9 +247,6 @@ local config = {
|
|||||||
elseif name == 'builtin' then
|
elseif name == 'builtin' then
|
||||||
return 'VIM'
|
return 'VIM'
|
||||||
end
|
end
|
||||||
if name == 'tohtml' then
|
|
||||||
return 'Lua module: tohtml'
|
|
||||||
end
|
|
||||||
return 'Lua module: vim.' .. name
|
return 'Lua module: vim.' .. name
|
||||||
end,
|
end,
|
||||||
helptag_fmt = function(name)
|
helptag_fmt = function(name)
|
||||||
@@ -261,8 +256,6 @@ local config = {
|
|||||||
return 'lua-vim-system'
|
return 'lua-vim-system'
|
||||||
elseif name == '_options' then
|
elseif name == '_options' then
|
||||||
return 'lua-vimscript'
|
return 'lua-vimscript'
|
||||||
elseif name == 'tohtml' then
|
|
||||||
return 'tohtml'
|
|
||||||
end
|
end
|
||||||
return 'vim.' .. name:lower()
|
return 'vim.' .. name:lower()
|
||||||
end,
|
end,
|
||||||
@@ -436,6 +429,21 @@ local config = {
|
|||||||
return { 'vim.pack' }
|
return { 'vim.pack' }
|
||||||
end,
|
end,
|
||||||
},
|
},
|
||||||
|
plugins = {
|
||||||
|
filename = 'plugins.txt',
|
||||||
|
section_order = {
|
||||||
|
'tohtml.lua',
|
||||||
|
},
|
||||||
|
files = {
|
||||||
|
'runtime/lua/tohtml.lua',
|
||||||
|
},
|
||||||
|
section_fmt = function(name)
|
||||||
|
return 'Builtin plugin: ' .. name:lower()
|
||||||
|
end,
|
||||||
|
helptag_fmt = function(name)
|
||||||
|
return name:lower()
|
||||||
|
end,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
--- @param ty string
|
--- @param ty string
|
||||||
|
Reference in New Issue
Block a user