Skip to content

distek/fnote.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 

Repository files navigation

fnote

Super simple, toggle-able, project notes floating window

Installation

  • Lazy:
{
    'distek/fnote.nvim',
    config = function()
        require('fnote').setup()
    end
},
  • Packer:
use {
    'distek/fnote.nvim',
    config = function()
        require('fnote').setup()
    end
}
  • Plug:
Plug 'distek/aftermath.nvim'

Configuration

Default configuration:

{
	anchor = "NE", -- NW, SW, NE, SE, or center
	window = { -- width/height of the window (can be percent)
		width = 40,
		height = 40,
		percent = true, -- interpret width/height as percent instead of fixed values
		offset = { -- Position offset from anchor
			x = 0,
			y = 0,
		},
		border = "single", -- border, see :h nvim_win_set_config
	},
	notes_file = "notes.md", -- project local notes file to use
}

During setup:

{
    'distek/fnote.nvim',
    config = function()
        require('fnote').setup({
            anchor = "E",
            window = {
                offset = {
                    x = 3,
                    y = 4,
                },
            }
        })
    end
},

Exposed functions

-- Open the window
require('fnote').open()

-- Close the window
require('fnote').close()

-- Toggle the window
require('fnote').toggle()

Highlight group

Customize FNoteWindow if desired

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages