X-Git-Url: https://git.r.bdr.sh/rbdr/nota.nvim/blobdiff_plain/56292c7915662bbf721ca8c3d2cee6a04134a9c6..refs/heads/main:/README.md?ds=inline diff --git a/README.md b/README.md index 520345c..87238ad 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,12 @@ The minimal setup doesn't require any configuration, and sets the default paths ```lua require('lazy').setup({ - 'git@git.sr.ht:~rbdr/nota.nvim', + 'https://git.sr.ht/~rbdr/nota.nvim', }) ``` +This plugin has an optional dependency: [fzf-lua][fzf-lua]. + 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. ```lua @@ -67,8 +69,6 @@ require('lazy').setup({ }) ``` -If the default directories don't work for you, you can override them as well: - ## Default Keybinds ### Opening Notes @@ -77,18 +77,23 @@ If the default directories don't work for you, you can override them as well: - `om`, `:NotaOpenMonthlyNote`, Opens this month's monthly note. - `os`, `:NotaOpenSeasonalNote`, Opens this season's seasonal note. - `oy`, `:NotaOpenYearlyNote`, Opens this year's yearly note. -- `on`, `:NotaOpenNote`, Opens an arbitrary note. +- `on`, `:NotaOpenNote`, Opens an arbitrary note. (Requires [fzf-lua][fzf-lua]) +- `N`, `:NotaOpenNextNote`, Opens the next periodic note. (eg. tomorrow or next year) +- `P`, `:NotaOpenPreviousNote`, Opens the previous periodic note. (eg. yesterday or last week) ### Task Views - `oa`, `:NotaOpenAgenda`, Opens the agenda window with this week's tasks. - `oo`, `:NotaOpenOpen`, Opens a window that lets you navigate through all open tasks. -- `oj`, `:NotaOpenJournal`, Opens a window that lets you search completed tasks to find journal entries. +- `oO`, `:NotaOpenOpenImportant`, Opens a window that lets you navigate through all open important tasks. +- `oj`, `:NotaOpenJournal`, Opens a window that lets you search completed tasks to find journal entries. (Requires [fzf-lua][fzf-lua] and ripgrep) ### Task Handling Commands - `t`, `:NotaToggleTask`, Toggles completion state of the task under the cursor. +- `st`, `:NotaToggleTaskImportance`, Toggles importance state of the task under the cursor. (- [ ] is a regular task, * [ ] is an important task) - `it`, `:NotaInsertTask`, Inserts a task at cursor location. - `ct`, `:NotaCaptureTask`, Captures a new task into the inbox. - `Tt`, `:NotaTagTask`, Adds a tag to the current task. +- `Rt`, `:NotaRemoveTagTask`, Removes a tag from the current task. - `rt`, `:NotaRescheduleTaskToday`, Reschedules the task under the cursor to today. - `rT`, `:NotaRescheduleTaskTomorrow`, Reschedules the task under the cursor to tomorrow. - `rs`, `:NotaRescheduleTaskSomeday`, Reschedules the task under the cursor to someday. @@ -101,3 +106,5 @@ If the default directories don't work for you, you can override them as well: ### Plan Handling Commands - `op`, `:NotaOpenPlan`, Opens the current plan file. - `cp`, `:NotaCapturePlan`, Captures a new plan and archives the current one. + +[fzf-lua]: https://github.com/ibhagwan/fzf-lua