jot.nvim

Commands • Usage • Installation • Configuration

jot.nvim is a CLI tool for quickly navigating between markdown notes in neovim. jot.nvim recognizes links of the form [[note-name]] and [[note-name|link text]] and provides completions and syntax highlighting to make links easier to read and write.

Usage

Navigating between notes

When your cursor is within the bounds of a link of the form [[note-name]] or [[note-name|link text]], you can navigate to that note by envoking the :JotJump command.

Creating notes

If the note does not already exist, use :JotJump --force instead to create the note in the active buffer's directory and navigate to it.

Commands

:JotJump                # Jump to note
:JotJump --force (-f)   # Jump to note, and create note if it does not exist
:JotList                # List all accessible notes

Installation

Add https://github.com/DevinLeamy/jot.nvim.git to vim-plug, packer, or any other nvim package manager.

-- ex: packer
require('packer').startup(function(use)
 -- ...
 use 'https://github.com/DevinLeamy/jot.nvim.git'
 -- ...
end)

Configuration

require("jot").setup({
    -- Directories to query for notes
    directories = {
      "~/vaults/daily_notes",
      "~/projects",
    },
    -- Enable completions
    display_completions = true,
})

" ex: bindings
nnoremap <Leader>f :JotJump<CR>
nnoremap <Leader>F :JotJump --force<CR>