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