bookmarks.nvim/README.md

bookmarks.nvim

A Bookmarks Plugin With Global File Store For Neovim Written In Lua.

Requirements

• Neovim >= 0.7.0

Installation

With packer.nvim:

use {
'tomasky/bookmarks.nvim',
-- tag = 'release' -- To use the latest release
}

Usage

For basic setup with all default configs using packer.nvim

use {
  'tomasky/bookmarks.nvim',
  config = function()
    require('bookmarks').setup()
  end
}

Here is an example with most of the default settings:

require('bookmarks').setup {
  save_file = "$HOME/.bookmarks",
  on_attach = function(bufnr)
    local bm = require "bookmarks"
    local map = vim.keymap.set
    map("n","mm",bm.bookmark_toggle)
    map("n","mc",bm.bookmark_clean)
    map("n","mi",bm.bookmark_ann)
  end
}

Credits

• gitsigns.nvim most of lua functions come from this plugin
• vim-bookmarks inspired by this vim plugin
• possession.nvim some util functions