README.md

mark-radar.nvim

Scan and highlight all marks in your buffer.

Installation

Requirements

• Neovim version 0.5 or newer.

Plugin Managers

lazy.nvim

{
    'winston0410/mark-radar.nvim',
    config = function()
        require('mark-radar').setup({
            -- options
        })
    end,
}

paq.nvim

paq{'winston0410/mark-radar.nvim'}

packer.nvim

use
{
    'winston0410/mark-radar.nvim',
    require("mark-radar").setup{
        -- your options here, such as:
        -- highlight_group = "<group_name>"
   }
}

vim-plug

Plug 'winston0410/mark-radar.nvim'

More Information

After you have installed, call setup to start using this plugin.

require("mark-radar").setup()

Configuration

This is the default configuration.

local opts = {
    set_default_mappings = true,
    highlight_group = "RadarMark",
    background_highlight = true,
    background_highlight_group = "RadarBackground",
    text_position = "overlay",
    show_marks_at_jump_positions = true,
    show_off_screen_marks = true,
}

You can pass a table in setup() to override the default configuration.

require("mark-radar").setup(opts)

Possible values for text_position are "eol", "overlay", "right_align", and "inline". See the virt_text_pos description in :h nvim_buf_set_extmark for more information.

Usage

The default mappings to activate mark-radar are the backtick/grave key (`) and the apostrophe key ('). See :h mark-motions for details.

Inspiration

This plugin is greatly inspired by hop.nvim