Skip to content

josiahdenton/inline-session-notes.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

inline-session-notes.nvim

Create inline notes for your nvim session.

Why?

  • before diving straight into a problem, I like to quickly write up a plan / annotate the codebase
  • I use comments, but I don't want them to stay / show in a diff, they're short lived and not vital

This is where inline-session-notes comes in! You can quickly annotate code with comments that will live as long as your neovim session remains open.

Caution

while you can use the plugin, it may not be bug free! file an issue if you find anything (or open a PR)

What's Next?

  • documentation
  • more customization / options

Install

{
    "josiahdenton/inline-session-notes.nvim",
    config = function()
        local inline = require("inline-session-notes")
        inline.setup({
            border = true, -- if you want your notes to have borders
        })

        vim.keymap.set("n", "<leader>ta", function()
            inline.add()
        end)

        vim.keymap.set("n", "<leader>te", function()
            inline.edit()
        end)

        vim.keymap.set("n", "<leader>td", function()
            inline.delete()
        end)
    end,
},

Usage

image image

Demo

demo_inline_notes.mov

About

virtual text notes that live for as long as the nvim session

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages