Skip to content

Commit d7e0c7a

Browse files
committed
update documentation
1 parent f698ae7 commit d7e0c7a

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ The fork aims to stay close to the original, but fix bugs, include and merge use
9797

9898
- `:Obsidian toc` to load the table of contents of the current note into a picker list.
9999

100+
- `:Obsidian tasks [STATUS]` to load the list of tasks of the current vault into a picker list.
101+
100102
### Demo
101103

102104
[![2024-01-31 14 22 52](https://github.com/epwalsh/obsidian.nvim/assets/8812459/2986e1d2-13e8-40e2-9c9e-75691a3b662e)](https://github.com/epwalsh/obsidian.nvim/assets/8812459/2986e1d2-13e8-40e2-9c9e-75691a3b662e)
@@ -520,12 +522,12 @@ This is a complete list of all of the options that can be passed to `require("ob
520522
max_file_length = 5000, -- disable UI features for files with more than this many lines
521523
-- Define how various check-boxes are displayed
522524
checkboxes = {
523-
-- NOTE: the 'char' value has to be a single character, and the highlight groups are defined below.
524-
[" "] = { char = "󰄱", hl_group = "ObsidianTodo" },
525-
["x"] = { char = "", hl_group = "ObsidianDone" },
526-
[">"] = { char = "", hl_group = "ObsidianRightArrow" },
527-
["~"] = { char = "󰰱", hl_group = "ObsidianTilde" },
528-
["!"] = { char = "", hl_group = "ObsidianImportant" },
525+
-- NOTE: the 'char' value and the status has to be a single character, and the highlight groups are defined below.
526+
[" "] = { char = "󰄱", order = 1, name = "todo", hl_group = "ObsidianTodo" },
527+
["x"] = { char = "", order = 2, name = "done", hl_group = "ObsidianDone" },
528+
[">"] = { char = "", order = 3, name = "doing", hl_group = "ObsidianRightArrow" },
529+
["~"] = { char = "󰰱", order = 4, name = "cancelled", hl_group = "ObsidianTilde" },
530+
["!"] = { char = "", order = 5, name = "important", hl_group = "ObsidianImportant" },
529531
-- Replace the above with this if you don't have a patched font:
530532
-- [" "] = { char = "☐", hl_group = "ObsidianTodo" },
531533
-- ["x"] = { char = "✔", hl_group = "ObsidianDone" },

lua/obsidian/config.lua

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -451,11 +451,11 @@ config.UIOpts.default = function()
451451
update_debounce = 200,
452452
max_file_length = 5000,
453453
checkboxes = {
454-
[" "] = { order = 1, name = "todo", char = "󰄱", hl_group = "ObsidianTodo" },
455-
["~"] = { order = 2, name = "doing", char = "󰰱", hl_group = "ObsidianTilde" },
456-
["!"] = { order = 3, name = "important", char = "", hl_group = "ObsidianImportant" },
457-
[">"] = { order = 4, name = "next", char = "", hl_group = "ObsidianRightArrow" },
458-
["x"] = { order = 5, name = "done", char = "", hl_group = "ObsidianDone" },
454+
[" "] = { char = "󰄱", order = 1, name = "todo", hl_group = "ObsidianTodo" },
455+
["x"] = { char = "", order = 2, name = "done", hl_group = "ObsidianDone" },
456+
[">"] = { char = "", order = 3, name = "doing", hl_group = "ObsidianRightArrow" },
457+
["~"] = { char = "󰰱", order = 4, name = "cancelled", hl_group = "ObsidianTilde" },
458+
["!"] = { char = "", order = 5, name = "important", hl_group = "ObsidianImportant" },
459459
},
460460
bullets = { char = "", hl_group = "ObsidianBullet" },
461461
external_link_icon = { char = "", hl_group = "ObsidianExtLinkIcon" },

0 commit comments

Comments
 (0)