/sfm-bookmark.nvim

Primary LanguageLuaMIT LicenseMIT

sfm-bookmark.nvim

The sfm-bookmark extension is a plugin for the sfm plugin that adds bookmark functionality to the sfm file explorer. With sfm-bookmark, you can easily mark and navigate between files in your project.

Demonstration

Here is a short demonstration of the sfm-bookmark extension in action:

sfm-bookmark-demo.mp4

Installation

To install the sfm-bookmark extension, you will need to have the sfm plugin installed. You can then install the extension using your preferred plugin manager. For example, using packer.nvim:

{
  "dinhhuy258/sfm.nvim",
  requires = {
    { "dinhhuy258/sfm-bookmark.nvim" },
  },
  config = function()
    local sfm_explorer = require("sfm").setup {}
    sfm_explorer:load_extension "sfm-bookmark"
  end
}

Configuration

The sfm-bookmark plugin provides the following configuration options:

local default_config = {
  mappings = {
    bookmark_mark = { "m" },
    bookmark_load = { "`" },
  },
}

You can override the default configuration in load_extension method

sfm_explorer:load_extension("sfm-bookmark", {
  mappings = {
    bookmark_mark = { "m" },
    bookmark_load = { "`" },
  },
})