]>
Commit | Line | Data |
---|---|---|
c0539eea RBR |
1 | # oleoboard.nvim |
2 | ||
3652b39d RBR |
3 | A tool to use [oil][oil] panes as a kanban-like board. |
4 | ||
5 | When summoned it will load the directories in the current directory as columns. | |
6 | It depends on oil so it assumes that these are editable. You can then move | |
7 | files from one board to another as if you were moving tasks in a kanban board. | |
c0539eea RBR |
8 | |
9 | ## Installation | |
10 | ||
11 | ### lazy.nvim | |
12 | ||
13 | ```lua | |
14 | require('lazy').setup({ | |
15 | { | |
16 | 'https://git.sr.ht/~rbdr/oleoboard.nvim', | |
17 | dependencies = { | |
18 | 'stevearc/oil.nvim' | |
19 | } | |
20 | } | |
21 | }) | |
22 | ``` | |
23 | ||
24 | By default, oleo-board adds keybinds that might not suit your style or conflict | |
25 | with other plugins. You can disable them with the `default_keybinds` option. | |
26 | ||
27 | ```lua | |
28 | require('lazy').setup({ | |
29 | { | |
30 | 'https://git.sr.ht/~rbdr/oleoboard.nvim', | |
31 | dependencies = { | |
32 | 'stevearc/oil.nvim' | |
33 | }, | |
34 | opts = { | |
35 | default_keybinds = false | |
36 | } | |
37 | }) | |
38 | ``` | |
39 | ||
40 | ## Default Keybinds | |
41 | ||
29a0f45b RBR |
42 | - `<leader>bb`, `:OleoBoardToggle`, Opens and Closes the kanban board |
43 | - `<leader>bl`, `:OleoBoardMoveEntryRight`, Moves the current entry to the right | |
44 | - `<leader>bL`, `:OleoBoardMoveColumnRight`, Moves the current column to the right | |
45 | - `<leader>bh`, `:OleoBoardMoveEntryLeft`, Moves the current entry to the left | |
46 | - `<leader>bH`, `:OleoBoardMoveColumnLeft`, Moves the current column to the left | |
c0539eea RBR |
47 | |
48 | [oil]: https://github.com/stevearc/oil.nvim |