git.r.bdr.sh - rbdr/oleoboard.nvim/blob - README.md

   1 # oleoboard.nvim
   2
   3 A tool to use [oil][oil] panes as a kanban board.
   4
   5 ## Installation
   6
   7 ### lazy.nvim
   8
   9 ```lua
  10 require('lazy').setup({
  11     {
  12         'https://git.sr.ht/~rbdr/oleoboard.nvim',
  13         dependencies = {
  14             'stevearc/oil.nvim'
  15         }
  16     }
  17 })
  18 ```
  19
  20 By default, oleo-board adds keybinds that might not suit your style or conflict
  21 with other plugins. You can disable them with the `default_keybinds` option.
  22
  23 ```lua
  24 require('lazy').setup({
  25   {
  26     'https://git.sr.ht/~rbdr/oleoboard.nvim',
  27     dependencies = {
  28         'stevearc/oil.nvim'
  29     },
  30     opts = {
  31         default_keybinds = false
  32     }
  33 })
  34 ```
  35
  36 ## Default Keybinds
  37
  38 - `bb`, `:OleoBoardToggle`, Opens and Closes the kanban board
  39 - `bl`, `:OleoBoardMoveEntryRight`, Moves the current entry to the right
  40 - `bL`, `:OleoBoardMoveColumnRight`, Moves the current column to the right
  41 - `bh`, `:OleoBoardMoveEntryLeft`, Moves the current entry to the left
  42 - `bH`, `:OleoBoardMoveColumnLeft`, Moves the current column to the left
  43
  44 [oil]: https://github.com/stevearc/oil.nvim