diff options
author | iurii plugatarov <[email protected]> | 2024-08-02 23:01:35 +0200 |
---|---|---|
committer | iurii plugatarov <[email protected]> | 2024-08-02 23:01:35 +0200 |
commit | f4a1319352d466308cd85eb1263aef9fd2c54293 (patch) | |
tree | 335eac92b9f9f47cec3d9bf60d7699d9fa8d66d7 /README.md | |
download | sketchbook.nvim-f4a1319352d466308cd85eb1263aef9fd2c54293.tar.gz |
init
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f67702d --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# sketchbook.nvim - simple notetaking + +Motivationg behind this thing, that I tried lots of notetaking tools but nothing really clicked. +I didn't want to leave nvim and it's not really convenient to manage ~/notes directory. + + +## Warn + +This was quick and dirty implementation, so not everything will perfectly because currently its in "works on my machine" state. + + +## Features + +- **Quick Note Creation**: Quickly create and manage notes. +- **Template Selection**: Choose from predefined templates for your notes. +- **Note Searching**: Search through your notes easily. +- **Git Integration**: Commit and push your notes to a Git repository. +- **Floating Windows**: Use floating windows for quick notes. + +## Installation + +You can install Sketchbook using [lazy.nvim](https://github.com/folke/lazy.nvim). + +### Using [lazy.nvim](https://github.com/folke/lazy.nvim) + +Add the following to your `lazy.nvim` configuration: + +```lua +require('lazy').setup({ + { + 'makefunstuff/sketchbook.nvim', + config = function() + require('sketchbook').setup({ + notes_directory = "~/my_notes/", + templates_directory = "~/my_notes/templates/", + keymaps = { + create_note = "<leader>nc", + update_index = "<leader>ni", + search_notes = "<leader>ns", + select_template = "<leader>nt", + create_quick_note = "<leader>nq", + toggle_quick_note = "<leader>qc", -- Keymap for toggling quick note window + open_entire_quick_note = "<leader>nqe", + commit_notes = "<leader>ngc", -- Keymap for committing notes + push_notes = "<leader>ngp", -- Keymap for pushing notes + } + }) + end + } +}) + +``` + +## TODO: + +- [ ] improve git Integration +- [ ] fix telescope issues with indexing +- [ ] add auto indexing |