Merge branch 'master' of github.com:hedyhli/symbols-outline.nvim

doc/symbols-outline.txt

@@ -168,7 +168,7 @@ Lazy:
     {
       "simrat39/symbols-outline.nvim",
       config = function()
-        -- Example mapping to toggle symbols-outline
+        -- Example mapping to toggle outline
         vim.keymap.set("n", "<leader>tt", "<cmd>SymbolsOutline<CR>",
           { desc = "SymbolsOutline" })
     
@@ -184,19 +184,20 @@ Lazy with lazy-loading:
 >lua
     {
       "simrat39/symbols-outline.nvim",
-      cmd = { "SymbolsOutline", "SymbolsOutlineOpen", "SymbolsOutlineClose" },
+      cmd = { "SymbolsOutline", "SymbolsOutlineOpen" },
-      keys = { "<leader>tt" },
+      keys = {
-      config = function()
+        -- Example mapping to toggle outline
-        -- Example mapping to toggle symbols-outline
+        { "<leader>tt", "<cmd>SymbolsOutline<CR>", desc = "Toggle outline window" },
-        vim.keymap.set("n", "<leader>tt", "<cmd>SymbolsOutline<CR>",
+      },
-          { desc = "SymbolsOutline" })
+      opts = {
-        require("symbols-outline").setup {
+        -- Your setup opts here
-          -- Your setup opts here (leave empty to use defaults)
+      },
-        }
-      end,
     },
 <
 
+This allows Lazy.nvim to lazy load the plugin on commands `SymbolsOutline`,
+`SymbolsOutlineOpen`, and your keybindings.
+
 
 SETUP                             *symbols-outline-symbols-outline.nvim-setup*
 
@@ -230,6 +231,7 @@ Pass a table to the setup call above with your configuration options.
       show_relative_numbers = false,
       show_cursorline = true,
       show_symbol_details = true,
+      -- Highlight group for the preview background
       preview_bg_highlight = 'Pmenu',
       autofold_depth = nil,
       auto_unfold_hover = true,
@@ -242,12 +244,16 @@ Pass a table to the setup call above with your configuration options.
       focus_on_open = true,
       keymaps = { -- These keymaps can be a string or a table for multiple keys
         close = {"<Esc>", "q"},
+        -- Jump to symbol under cursor
         goto_location = "<Cr>",
+        -- Jump to symbol under cursor but keep focus on outline window
         focus_location = "o",
         hover_symbol = "<C-space>",
+        -- Preview symbol under cursor
         toggle_preview = "K",
         rename_symbol = "r",
         code_actions = "a",
+        -- These fold actions are collapsing tree items, not code folding
         fold = "h",
         fold_toggle = '<tab>',       -- Only in this fork
         fold_toggle_all = '<S-tab>', -- Only in this fork
@@ -368,17 +374,20 @@ COMMANDS                       *symbols-outline-symbols-outline.nvim-commands*
   :SymbolsOutlineFocusOutline   Focus on symbols outline
   :SymbolsOutlineFocusCode      Focus on source window
 
-LUA ~
+LUA API ~
 
 >lua
-    require'symbols-outline'.toggle_outline()
+    require'symbols-outline'
-    require'symbols-outline'.open_outline()
-    require'symbols-outline'.close_outline()
-    require'symbols-outline'.focus_toggle()
-    require'symbols-outline'.focus_outline()
-    require'symbols-outline'.focus_code()
 <
 
+- setup(opts)
+- toggle_outline()
+- open_outline()
+- close_outline()
+- focus_toggle()
+- focus_outline()
+- focus_code()
+
 
 DEFAULT KEYMAPS         *symbols-outline-symbols-outline.nvim-default-keymaps*