Document missing option

README.md

@@ -81,39 +81,55 @@ vim.g.aerial = {
   --   auto    - aerial window will stay open as long as there is a visible
   --             buffer to attach to
   close_behavior = 'auto',
+
+  -- Set to false to remove the default keybindings for the aerial buffer
+  default_bindings = true,
+
   -- Enum: prefer_right, prefer_left, right, left
   -- Determines the default direction to open the aerial window. The 'prefer'
   -- options will open the window in the other direction *if* there is a
   -- different buffer in the way of the preferred direction
   default_direction = 'prefer_right',
+
   -- Fetch document symbols when LSP diagnostics change.
   -- If you set this to false, you will need to manually fetch symbols
   diagnostics_trigger_update = true,
+
   -- Enum: split_width, full_width, last, none
   -- Determines line highlighting mode when multiple buffers are visible
   highlight_mode = 'split_width',
+
   -- When jumping to a symbol, highlight the line for this many ms
   -- Set to 0 or false to disable
   highlight_on_jump = 300,
+
   -- The maximum width of the aerial window
   max_width = 40,
+
   -- The minimum width of the aerial window.
   -- To disable dynamic resizing, set this to be equal to max_width
   min_width = 10,
+
   -- Set default symbol icons to use Nerd Font icons (see https://www.nerdfonts.com/)
   nerd_font = 'auto',
+
   -- Whether to open aerial automatically when entering a buffer.
   -- Can also be specified per-filetype as a map (see below)
   open_automatic = false,
+
   -- If open_automatic is true, only open aerial if the source buffer is at
   -- least this long
   open_automatic_min_lines = 0,
+
   -- If open_automatic is true, only open aerial if there are at least this many symbols
   open_automatic_min_symbols = 0,
+
   -- Run this command after jumping to a symbol ('' will disable)
   post_jump_cmd = 'normal! zvzz',
+
   -- Set to false to not update the symbols when there are LSP errors
   update_when_errors = true,
+
   -- A list of all symbols to display. Set to false to show all symbols.
   filter_kind = {
     "Class",
@@ -167,7 +183,8 @@ These are the values used for configuring icons, highlight groups, and
 filtering.
 
 ## Default Keybindings
-The default keybindings in the aerial window are 
+The default keybindings in the aerial window. You can remove these by setting
+`g:aerial_default_bindings = 0`, and add your own in `.vim/ftplugin/aerial.vim`
 
 Key     | Command
 ---     | -------

doc/aerial.txt

@@ -70,6 +70,9 @@ g:aerial_close_behavior                                 *g:aerial_close_behavior
         auto          Stay open as long as there is a visible buffer to attach
                       to (default)
 
+g:aerial_default_bindings                             *g:aerial_default_bindings*
+    If `false`, don't set up the default keybindings in the aerial buffer.
+
 g:aerial_default_direction                           *g:aerial_default_direction*
     The default direction to open the window. Valid values are:
         left          Open the split to the left
@@ -147,9 +150,6 @@ g:aerial_post_jump_cmd                                   *g:aerial_post_jump_cmd
 g:aerial_update_when_errors                         *g:aerial_update_when_errors*
     Update the aerial buffer even when your file has LSP errors. Default `true`.
 
-g:aerial_default_bindings                             *g:aerial_default_bindings*
-    If `false`, don't set up the default keybindings in the aerial buffer.
-
 g:aerial_icons                                                   *g:aerial_icons*
     A map of |SymbolKind| to icons. You can also specify "<Symbol>Collapsed"
     to change the icon when the tree is collapsed at this symbol, or

ftplugin/aerial.vim

@@ -1,4 +1,4 @@
-if !get(g:, 'aerial_default_bindings', 1)
+if !get(g:, 'aerial_default_bindings', 1) || !get(get(g:, 'aerial', {}), 'default_bindings', 1)
   finish
 endif
 " Use <CR> to jump to the location, just like with the quickfix

lua/aerial/config.lua

@@ -9,39 +9,55 @@ local default_options = {
   --   auto    - aerial window will stay open as long as there is a visible
   --             buffer to attach to
   close_behavior = 'auto',
+
+  -- Set to false to remove the default keybindings for the aerial buffer
+  default_bindings = true,
+
   -- Enum: prefer_right, prefer_left, right, left
   -- Determines the default direction to open the aerial window. The 'prefer'
   -- options will open the window in the other direction *if* there is a
   -- different buffer in the way of the preferred direction
   default_direction = 'prefer_right',
+
   -- Fetch document symbols when LSP diagnostics change.
   -- If you set this to false, you will need to manually fetch symbols
   diagnostics_trigger_update = true,
+
   -- Enum: split_width, full_width, last, none
   -- Determines line highlighting mode when multiple buffers are visible
   highlight_mode = 'split_width',
+
   -- When jumping to a symbol, highlight the line for this many ms
   -- Set to 0 or false to disable
   highlight_on_jump = 300,
+
   -- The maximum width of the aerial window
   max_width = 40,
+
   -- The minimum width of the aerial window.
   -- To disable dynamic resizing, set this to be equal to max_width
   min_width = 10,
+
   -- Set default symbol icons to use Nerd Font icons (see https://www.nerdfonts.com/)
   nerd_font = 'auto',
+
   -- Whether to open aerial automatically when entering a buffer.
   -- Can also be specified per-filetype as a map (see below)
   open_automatic = false,
+
   -- If open_automatic is true, only open aerial if the source buffer is at
   -- least this long
   open_automatic_min_lines = 0,
+
   -- If open_automatic is true, only open aerial if there are at least this many symbols
   open_automatic_min_symbols = 0,
+
   -- Run this command after jumping to a symbol ('' will disable)
   post_jump_cmd = 'normal! zvzz',
+
   -- Set to false to not update the symbols when there are LSP errors
   update_when_errors = true,
+
   -- A list of all symbols to display
   filter_kind = {
     "Class",