https://github.com/devinleamy/jot.nvim

Rapid Navigation Between [[Notes]] 💨
https://github.com/devinleamy/jot.nvim

Last synced: 16 days ago
JSON representation

Rapid Navigation Between [[Notes]] 💨

• Host: GitHub
• URL: https://github.com/devinleamy/jot.nvim
• Owner: DevinLeamy
• Created: 2022-10-11T03:21:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-28T03:43:42.000Z (about 2 years ago)
• Last Synced: 2023-03-05T17:39:17.270Z (almost 2 years ago)
• Language: Lua
• Homepage:
• Size: 38.1 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# *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

```bash

: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](https://github.com/junegunn/vim-plug), [packer](https://github.com/wbthomason/packer.nvim), or any other `nvim` package manager.

```lua

-- ex: packer

require('packer').startup(function(use)

 -- ...

 use 'https://github.com/DevinLeamy/jot.nvim.git'

 -- ...

end)

```

## Configuration

```lua

require("jot").setup({

    -- Directories to query for notes

    directories = {

      "~/vaults/daily_notes",

      "~/projects",

    },

    -- Enable completions

    display_completions = true,

})

```

```vim

" ex: bindings

nnoremap f :JotJump

nnoremap F :JotJump --force

```