diff --git a/doc/lsp-lens-docs.txt b/doc/lsp-lens-docs.txt index e69de29..55fc303 100644 --- a/doc/lsp-lens-docs.txt +++ b/doc/lsp-lens-docs.txt @@ -0,0 +1,122 @@ +*lsp-lens-docs.txt* For Neovim >= 0.8.0 Last change: 2023 October 29 + +============================================================================== +Table of Contents *lsp-lens-docs-table-of-contents* + +1. lsp-lens.nvim |lsp-lens-docs-lsp-lens.nvim| + - Installation |lsp-lens-docs-lsp-lens.nvim-installation| + - Configs |lsp-lens-docs-lsp-lens.nvim-configs| + - Commands |lsp-lens-docs-lsp-lens.nvim-commands| + - Highlight |lsp-lens-docs-lsp-lens.nvim-highlight| + - Known Bug |lsp-lens-docs-lsp-lens.nvim-known-bug| + - Thanks |lsp-lens-docs-lsp-lens.nvim-thanks| + +============================================================================== +1. lsp-lens.nvim *lsp-lens-docs-lsp-lens.nvim* + +Neovim plugin for displaying reference and definition info upon functions like +JB’s IDEA. + + + + +INSTALLATION *lsp-lens-docs-lsp-lens.nvim-installation* + + +PREREQUISITE ~ + +neovim >= 0.8 + +lsp server correctly setup + + +LAZY ~ + +>lua + require("lazy").setup({ + 'VidocqH/lsp-lens.nvim' + }) +< + + +USAGE ~ + +>lua + require'lsp-lens'.setup({}) +< + + +CONFIGS *lsp-lens-docs-lsp-lens.nvim-configs* + +Below is the default config + +>lua + require'lsp-lens'.setup({ + enable = true, + include_declaration = false, -- Reference include declaration + sections = { -- Enable / Disable specific request, formatter example looks 'Format Requests' + definition = false, + references = true, + implements = true, + git_authors = true, + }, + ignore_filetype = { + "prisma", + }, + }) +< + + +FORMAT REQUESTS ~ + +>lua + require'lsp-lens'.setup({ + sections = { + definition = function(count) + return "Definitions: " .. count + end, + references = function(count) + return "References: " .. count + end, + implements = function(count) + return "Implements: " .. count + end, + git_authors = function(latest_author, count) + return " " .. latest_author .. (count - 1 == 0 and "" or (" + " .. count - 1)) + end, + } + }) +< + + +COMMANDS *lsp-lens-docs-lsp-lens.nvim-commands* + +> + :LspLensOn + :LspLensOff + :LspLensToggle +< + + +HIGHLIGHT *lsp-lens-docs-lsp-lens.nvim-highlight* + +>lua + { + LspLens = { link = "Comment" }, + } +< + + +KNOWN BUG *lsp-lens-docs-lsp-lens.nvim-known-bug* + +- Due to a known issue with the neovim `nvim_buf_set_extmark()` api, the function and method defined on the first line of the code may cause the len to display at the -1 index line, which is not visible. + + +THANKS *lsp-lens-docs-lsp-lens.nvim-thanks* + +lspsaga by glepnir + + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: