Add oleoboard

diff --git a/index.gmi b/index.gmi
index f6cfcc0b1e7177797e6f18d83d31b33c08d7af79..d78c461d12abe41a1f43741f9985832678ded310 100644 (file)
--- a/index.gmi
+++ b/index.gmi
@@ -107,6 +107,13 @@ A plugin for neovim that lets you manage periodic notes, tasks, learning and .pl
 => ./nota.gmi ./nota.gmi
 => https://git.r.bdr.sh/rbdr/nota.nvim nota.nvim source code
 
+### oleoboard.nvim
+
+A plugin for neovim that lets you use directories as a kanban-like board
+
+=> ./oleoboard.gmi ./oleoboard.gmi
+=> https://git.r.bdr.sh/rbdr/oleoboard.nvim nota.nvim source code
+
 ### API Notation
 A syntax for notating component APIs in text documents. We provide a tree-sitter parser and a neovim plugin.
 

diff --git a/oleoboard.gmi b/oleoboard.gmi
new file mode 100644 (file)
index 0000000..851935c
--- /dev/null
+++ b/oleoboard.gmi
@@ -0,0 +1,59 @@
+--- 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://github.com/stevearc/oil.nvim [1] oil.nvim
+
+=> https://git.r.bdr.sh/rbdr/oleoboard.nvim view source @ git.r.bdr.sh
+=> https://git.sr.ht/~rbdr/oleoboard.nvim source mirror @ sourcehut
+
+## 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)