Use usage once

[rbdr/r.bdr.sh] / oleoboard.gmi

--- title: /oleoboard.html
--- description: oleoboard (.nvim) is a plugin to use directories as a kanban-like board.

## oleoboard.nvim

A tool to use directories as a kanban-like board.

When summoned it will load the directories in the current directory as columns so you can easily move files around.

It depends on oil[1] to provide the file management functionality.

=> https://git.r.bdr.sh/rbdr/oleoboard.nvim ⧇ source
=> https://git.sr.ht/~rbdr/oleoboard.nvim ⧉ mirror
=> https://github.com/stevearc/oil.nvim [1] oil.nvim

## Installation

### lazy.nvim

```lua
require('lazy').setup({
    {
        'https://git.sr.ht/~rbdr/oleoboard.nvim',
        dependencies = {
            'stevearc/oil.nvim'
        }
    }
})
```

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.

```lua
require('lazy').setup({
  {
    'https://git.sr.ht/~rbdr/oleoboard.nvim',
    dependencies = {
        'stevearc/oil.nvim'
    },
    opts = {
        default_keybinds = false
    }
})
```

## Keybinds

Unless disabled, these are the key bindings provided:

- `<leader>bb`, `:OleoBoardToggle`, Opens and Closes the kanban board
- `<leader>bl`, `:OleoBoardMoveEntryRight`, Moves the current entry to the right
- `<leader>bL`, `:OleoBoardMoveColumnRight`, Moves the current column to the right
- `<leader>bh`, `:OleoBoardMoveEntryLeft`, Moves the current entry to the left
- `<leader>bH`, `:OleoBoardMoveColumnLeft`, Moves the current column to the left

## An Example

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)