chore(build): auto-generate vimdoc

lucobellic · Jan 27, 2024 · 2478dfc · 2478dfc
1 parent e1b7c5e
commit 2478dfc
Showing 1 changed file with 40 additions and 4 deletions.
diff --git a/doc/edgy-group.nvim.txt b/doc/edgy-group.nvim.txt
@@ -1,4 +1,4 @@
-*edgy-group.nvim.txt*     For Neovim >= 0.8.0     Last change: 2024 January 23
+*edgy-group.nvim.txt*     For Neovim >= 0.8.0     Last change: 2024 January 27
 
 ==============================================================================
 Table of Contents                          *edgy-group.nvim-table-of-contents*
@@ -29,7 +29,8 @@ organizing windows within **edgebar** based on their title.
 
 - Switch between groups of windows within **edgebar**.
 - Add a command to navigate through groups of windows.
-- Allow the creation of custom icon indicators in the statusline, bufferline, etc.
+- Allow the creation of custom icon indicators in statusline, bufferline, etc.
+- Pick mode to select group from statusline
 
 
 ==============================================================================
@@ -97,14 +98,34 @@ OPTIONS                                        *edgy-group.nvim-usage-options*
         clickable = false, -- enable `open_group` on click
         colored = false, -- enable highlight support
         colors = { -- highlight colors
-          active = 'Normal',
-          inactive = 'Normal',
+          active = 'Normal', -- highlight color for open group
+          inactive = 'Normal', -- highlight color for closed group
+          pick_active = 'PmenuSel', -- highlight color for pick key for open group
+          pick_inactive = 'PmenuSel', -- highlight color for pick key for closed group
         },
       },
     }
 <
 
 
+GROUPS ~
+
+>lua
+    groups = {
+      right = { -- group position (right, left, bottom, top)
+        {
+          icon = '', -- icon used in statusline and vim.ui.select
+          titles = { 'Neo-Tree', 'Neo-Tree Buffers' }, -- list of titles from edgy.nvim
+          pick_key = 'f' -- key to pick a group in statusline
+        },
+      },
+    }
+<
+
+Groups without pick_key will be assigned to the first available key in
+alphabetical order.
+
+
 API                                                *edgy-group.nvim-usage-api*
 
 - **EdgyGroupSelect** select group to open with **vim.ui.select**.
@@ -113,6 +134,7 @@ API                                                *edgy-group.nvim-usage-api*
 - **require(‘edgy-group’).open_group_offset(position, offset)** open group with offset relative to the current group.
 - **require(‘edgy-group’).open_group_index(position, index)** open group with index relative to the current position.
 - **require(‘edgy-group.stl.statusline’).get_statusline(position)** get a list of string in statusline format for each group icons with optional highlight and click support.
+- **require(‘edgy-group.stl.statusline’).pick(callback)** enable picking mode to select group from statusline.
 
 
 ==============================================================================
@@ -139,6 +161,13 @@ Usage of **edgy-group.nvim** to create three groups for the left **edgebar**
           function() require('edgy-group').open_group_offset('left', -1) end,
           desc = 'Edgy Group Prev Left',
         },
+        {
+          '<c-,>',
+          function()
+            require('edgy-group.stl.statusline').pick()
+          end,
+          desc = 'Edgy Group Pick',
+        },
       },
       opts = {
         groups = {
@@ -211,6 +240,13 @@ LUALINE ~
     }
 <
 
+
+PICKING
+
+>lua
+    require('edgy-group.stl.statusline').pick(function() require('lualine').refresh() end)
+<
+
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl: