EvWilson/spelunk.nvim

github

marks

9

0

1

0

CREATED

2024-10-16

UPDATED

19 hours ago

---

spelunk.nvim

Marks not cutting it? Create and manage bookmarks more easily, with an easy to use and configurable UI.

Installation/Configuration

Via lazy:

require("lazy").setup({
    {
        'EvWilson/spelunk.nvim',
        dependencies = { 'nvim-lua/plenary.nvim' },
        config = function()
            require('spelunk').setup()
        end
    }
})

Want to configure the keybinds? Pass a config object to the setup function. Here's the default mapping object for reference:

{
    base_mappings = {
        toggle = '<leader>bt',
        add = '<leader>ba'
    },
    window_mappings = {
        cursor_down = 'j',
        cursor_up = 'k',
        bookmark_down = '<C-j>',
        bookmark_up = '<C-k',
        goto_bookmark = '<CR>',
        delete_bookmark = 'd',
        next_stack = '<Tab>',
        previous_stack = '<S-Tab>',
        new_stack = 'n',
        delete_stack = 'D',
        close = 'q',
        help = 'h', -- Not rebindable
    }
}

Check the mentioned help screen to see current keybinds and their use:

Compatibility/Support

This project will attempt to support the latest Neovim stable release. Issues or incompatibilities only replicable in nightly releases, or sufficiently older versions (>2 major versions back) will not be supported.

Thank you for your understanding!