marknav.nvim

Installation · Setup · Usage

---

A Neovim plugin designed to enhance your Markdown navigation experience.

Leveraging the power of Lua and Neovim built-in features, it offers an efficient way to follow links within Markdown documents, without the need for external dependencies. Intended to be minimal, fast, and simple to use.

Installation

lazy.nvim

{ 'daenikon/marknav.nvim' }

packer.nvim

use "daenikon/marknav.nvim"

vim-plug

Plug 'daenikon/marknav.nvim'

Setup

After installation, initialize marknav by adding the following to your Neovim configuration:

require("marknav").setup()

Usage

marknav.nvim is designed to work exclusively within Markdown files, offering the following commands and keybindings:

Command	Default Keybind	Description
:MarknavJump	Enter	Jump to the link under the cursor.
:MarknavTab	<Leader> + Enter	Open the link under the cursor in a new tab.
:MarknavBack	Backspace	Navigate back to the previous file.

Ensure you have a <Leader> key set in your init.lua for optimal use. For example, to set the spacebar as your leader key:

vim.g.mapleader = " "