Skip to content

This is my primitive/simple plugin for quick notes creating during my work in neovim.

License

Notifications You must be signed in to change notification settings

pilarskikt/qnotes.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


qNotes

This plugin is my primitive way of doing notes as i use NeoVim as my daily code editor. asciicast

Requirements

Installation

Using lazy.nvim

return {
    'pilarskikt/qnotes.nvim',
    dependencies={
        {'nvim-telescope/telescope.nvim', branch='0.1.x'}
    },
}

Configuration

You can configure the directory in which you want to keep your notes or stay with default which is ~/notes to configure directory please use notes_dir for example:

return {
    'pilarskikt/qnotes.nvim',
    dependencies={
        {'nvim-telescope/telescope.nvim', branch='0.1.x'}
    },
  opts = {
    notes_dir = "~/my_notes/custom/dir"
  },
}

User can also create use own keymaps which are create_note_keymap, search_note_keymap, 'create_line_note_keymap' and 'delete_line_note_keymap':

return {
    'pilarskikt/qnotes.nvim',
    dependencies={
        {'nvim-telescope/telescope.nvim', branch='0.1.x'}
    },
  opts = {
    create_note_keymap = "<leader>n",
    search_note_keymap = "<leader>f",
  },
}

Usage

At the moment there are four keymaps:
<leader>qn - for creating new note
<leader>qf - for searching through notes
<leader>ql - create new note for specific line of code(it will trigger creating(if doesnt exist) metadata file that keeps information about lines that have linked notes)
<leader>qd - delete note for current line\

When creating new note you will be asked for filename of the notes and tags. If filename is not provided qnotes will create journalfile named {CURRENT_DATE}-JOURNAL.MD the file is going to be created in journal subdirectory of your notes directory.

About

This is my primitive/simple plugin for quick notes creating during my work in neovim.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages