git.r.bdr.sh / rbdr / nota.nvim / blame
| Commit | Line | Data |
|---|---|---|
| 56292c79 RBR |
1 | # nota.nvim |
| 2 | ||
| 3 | Tools to work with notes and tasks in neovim. | |
| 4 | ||
| 5 | ## Installation | |
| 6 | ||
| 7 | ### lazy.nvim | |
| 8 | ||
| 9 | The minimal setup doesn't require any configuration, and sets the default paths and keybins as defined in the sections below. | |
| 10 | ||
| 11 | ```lua | |
| 12 | require('lazy').setup({ | |
| 13 | 'git@git.sr.ht:~rbdr/nota.nvim', | |
| 14 | }) | |
| 15 | ``` | |
| 16 | ||
| 17 | By default, nota adds keybinds that might not suit your style or conflict with other plugins. You can disable them with the `default_keybinds` option. | |
| 18 | ||
| 19 | ```lua | |
| 20 | require('lazy').setup({ | |
| 21 | { | |
| 22 | 'git@git.sr.ht:~rbdr/nota.nvim', | |
| 23 | opts = { | |
| 24 | default_keybinds = false | |
| 25 | } | |
| 26 | }) | |
| 27 | ``` | |
| 28 | ||
| 29 | Here's the full configuration with its default values: | |
| 30 | ||
| 31 | ```lua | |
| 32 | require('lazy').setup({ | |
| 33 | { | |
| 34 | 'git@git.sr.ht:~rbdr/nota.nvim', | |
| 35 | opts = { | |
| 36 | nota_home = '~/.local/share/nota', -- Root location in which to store all notes | |
| 37 | default_keybinds = true, -- Whether or not to set the default keybinds | |
| 38 | periodic_locations = { | |
| 39 | daily = 'periodic/daily', -- Location to store daily notes, relative to nota_home | |
| 40 | weekly = 'periodic/weekly', -- Location to store weekly notes, relative to nota_home | |
| 41 | monthly = 'periodic/monthly', -- Location to store monthly notes, relative to nota_home | |
| 42 | seasonal = 'periodic/seasonal', -- Location to store seasonal notes, relative to nota_home | |
| 43 | yearly = 'periodic/yearly' -- Location to store yearly notes, relative to nota_home | |
| 44 | }, | |
| 45 | templates = { | |
| 46 | daily = 'templates/daily.md', -- Template for daily notes, relative to nota_home | |
| 47 | weekly = 'templates/weekly.md', -- Template for weekly notes, relative to nota_home | |
| 48 | monthly = 'templates/monthly.md', -- Template for monthly notes, relative to nota_home | |
| 49 | seasonal = 'templates/seasonal.md', -- Template for seasonal notes, relative to nota_home | |
| 50 | yearly = 'templates/yearly.md', -- Template for yearly notes, relative to nota_home | |
| 51 | plan = 'templates/plan.md' -- Template for plan notes, relative to nota_home | |
| 52 | }, | |
| 53 | tasks = { | |
| 54 | inbox = 'inbox.md', -- Location of the file in which to store newly captured tasks, relative to nota_home | |
| 55 | someday = 'someday.md' -- Location of the file in which to store indefinitely deferred tasks, relative to nota_home | |
| 56 | }, | |
| 57 | learning = { | |
| 58 | learning_file = 'learning.md', -- Location of the file in which to store learning entries, relative to nota_home | |
| 59 | prefix = '%Y-%x-%d: ' -- Prefix to add when capturing learning entries | |
| 60 | }, | |
| 61 | plan = { | |
| 62 | archive = 'plans', -- Location of the plan archives. | |
| 63 | plan_file = '~/.plan' -- Location of the active plan, the default is what is expected by finger. | |
| 64 | } | |
| 65 | } | |
| 66 | } | |
| 67 | }) | |
| 68 | ``` | |
| 69 | ||
| 70 | If the default directories don't work for you, you can override them as well: | |
| 71 | ||
| 72 | ## Default Keybinds | |
| 73 | ||
| 74 | ### Opening Notes | |
| 75 | - `<leader>od`, `:NotaOpenDailyNote`, Opens today's daily note. | |
| 76 | - `<leader>ow`, `:NotaOpenWeeklyNote`, Opens this week's weekly note. | |
| 77 | - `<leader>om`, `:NotaOpenMonthlyNote`, Opens this month's monthly note. | |
| 78 | - `<leader>os`, `:NotaOpenSeasonalNote`, Opens this season's seasonal note. | |
| 79 | - `<leader>oy`, `:NotaOpenYearlyNote`, Opens this year's yearly note. | |
| 80 | - `<leader>on`, `:NotaOpenNote`, Opens an arbitrary note. | |
| 81 | ||
| 82 | ### Task Views | |
| 83 | - `<leader>oa`, `:NotaOpenAgenda`, Opens the agenda window with this week's tasks. | |
| 84 | - `<leader>oo`, `:NotaOpenOpen`, Opens a window that lets you navigate through all open tasks. | |
| 85 | - `<leader>oj`, `:NotaOpenJournal`, Opens a window that lets you search completed tasks to find journal entries. | |
| 86 | ||
| 87 | ### Task Handling Commands | |
| 88 | - `<leader>t`, `:NotaToggleTask`, Toggles completion state of the task under the cursor. | |
| 89 | - `<leader>it`, `:NotaInsertTask`, Inserts a task at cursor location. | |
| 90 | - `<leader>ct`, `:NotaCaptureTask`, Captures a new task into the inbox. | |
| 91 | - `<leader>Tt`, `:NotaTagTask`, Adds a tag to the current task. | |
| 92 | - `<leader>rt`, `:NotaRescheduleTaskToday`, Reschedules the task under the cursor to today. | |
| 93 | - `<leader>rT`, `:NotaRescheduleTaskTomorrow`, Reschedules the task under the cursor to tomorrow. | |
| 94 | - `<leader>rs`, `:NotaRescheduleTaskSomeday`, Reschedules the task under the cursor to someday. | |
| 95 | - `<leader>rr`, `:NotaRescheduleTask`, Reschedules the task under the cursor to an arbitrary date. | |
| 96 | ||
| 97 | ### Learning Handling Commands | |
| 98 | - `<leader>ol`, `:NotaOpenLearning`, Opens the learning file. | |
| 99 | - `<leader>cl`, `:NotaCaptureLearning`, Captures a new task into the inbox. | |
| 100 | ||
| 101 | ### Plan Handling Commands | |
| 102 | - `<leader>op`, `:NotaOpenPlan`, Opens the current plan file. | |
| 103 | - `<leader>cp`, `:NotaCapturePlan`, Captures a new plan and archives the current one. |