git.r.bdr.sh - rbdr/r.bdr.sh/blob - oleoboard.gmi

   1 --- title: /oleoboard.html
   2 --- description: oleoboard (.nvim) is a plugin to use directories as a kanban-like board.
   3
   4 ## oleoboard.nvim
   5
   6 A tool to use directories as a kanban-like board.
   7
   8 When summoned it will load the directories in the current directory as columns so you can easily move files around.
   9
  10 It depends on oil[1] to provide the file management functionality.
  11
  12 => https://github.com/stevearc/oil.nvim [1] oil.nvim
  13
  14 => https://git.r.bdr.sh/rbdr/oleoboard.nvim view source @ git.r.bdr.sh
  15 => https://git.sr.ht/~rbdr/oleoboard.nvim source mirror @ sourcehut
  16
  17 ## Installation
  18
  19 ### lazy.nvim
  20
  21 ```lua
  22 require('lazy').setup({
  23     {
  24         'https://git.sr.ht/~rbdr/oleoboard.nvim',
  25         dependencies = {
  26             'stevearc/oil.nvim'
  27         }
  28     }
  29 })
  30 ```
  31
  32 By default, oleoboard adds keybinds that might not suit your style or conflict with other plugins. You can disable them with the `default_keybinds` option.
  33
  34 ```lua
  35 require('lazy').setup({
  36   {
  37     'https://git.sr.ht/~rbdr/oleoboard.nvim',
  38     dependencies = {
  39         'stevearc/oil.nvim'
  40     },
  41     opts = {
  42         default_keybinds = false
  43     }
  44 })
  45 ```
  46
  47 ## Keybinds
  48
  49 Unless disabled, these are the key bindings provided:
  50
  51 - `<leader>bb`, `:OleoBoardToggle`, Opens and Closes the kanban board
  52 - `<leader>bl`, `:OleoBoardMoveEntryRight`, Moves the current entry to the right
  53 - `<leader>bL`, `:OleoBoardMoveColumnRight`, Moves the current column to the right
  54 - `<leader>bh`, `:OleoBoardMoveEntryLeft`, Moves the current entry to the left
  55 - `<leader>bH`, `:OleoBoardMoveColumnLeft`, Moves the current column to the left
  56
  57 ## An Example
  58
  59 As I work in blog entries I have four directories: ideas, writing, published, and cancelled. By opening them with oleoboard I can see them as a kanban board and easily move them around (eg. when I start writing an idea, or when I publish an article)