nvim-bookmarks's Introduction

Installation

lazy.nvim

return {
    "kdnk/nvim-bookmarks",
}

Configuration

return {
    "kdnk/nvim-bookmarks",
    config = function()
        local bm = require("bookmarks")

        bm.setup({
            persist = {
                enable = true,
                dir = "./.bookmarks", -- directory to store json file for backup. Please add `**/.bookmarks/*` to your `.gitignore_global`.
                per_branch = true, -- store backup file for each branch
            },
            sign = {
                text = "⚑",
            },
        })

        vim.keymap.set("n", "mm", bm.toggle) -- toggle bookmark at current line
        vim.keymap.set("n", "<C-,>", bm.jump_prev) -- jump to the previous bookmark over buffers
        vim.keymap.set("n", "<C-.>", bm.jump_next) -- jump to the next bookmark over buffers
        vim.keymap.set("n", "mx", bm.reset) -- remove all bookmarks
        vim.keymap.set("n", "mr", bm.restore) -- restore bookmarks from the json backup file

        -- autocmd to restore bookmarks from the json backup file
        local bookmarkGroup = vim.api.nvim_create_augroup("bookmark_auto_restore", {})
        vim.api.nvim_create_autocmd({ "VimEnter", "SessionLoadPost" }, {
            callback = function()
                bm.restore()
            end,
            group = bookmarkGroup,
        })
    end,
}

Integration

lualine

local function bookmark_count()
    return string.format([[📘 %s]], require("bookmarks.lualine").bookmark_count())
end

require("lualine").setup({
    sections = {
        lualine_c = {
            { bookmark_count },
        },
    },
})

Telescope

require("telescope").load_extension("bookmarks")
vim.keymap.set("n", "<leader>b", function() require("telescope").extensions.bookmarks.list() end)

Credit

nvim-bookmarks's People

Contributors

Stargazers

Watchers

nvim-bookmarks's Issues

Can't make it work

My setup

return {
    "kdnk/bookmarks-cycle-through.nvim",
    dependencies = {
        "MattesGroeger/vim-bookmarks",
    },
    lazy = false,
    config = function()
        vim.keymap.set("n", "mm", function()
            require("bookmarks-cycle-through").toggle_bookmark()
        end)
        vim.keymap.set("n", "]b", function()
            require("bookmarks-cycle-through").cycle_through({ reverse = false })
        end)
        vim.keymap.set("n", "[b", function()
            require("bookmarks-cycle-through").cycle_through({ reverse = true })
        end)
    end,
}