You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-31Lines changed: 31 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -48,54 +48,54 @@ The fork aims to stay close to the original, but fix bugs, include and merge use
48
48
49
49
### Commands
50
50
51
-
-`:ObsidianOpen [QUERY]` to open a note in the Obsidian app.
51
+
-`:Obsidian open [QUERY]` to open a note in the Obsidian app.
52
52
This command has one optional argument: a query used to resolve the note to open by ID, path, or alias. If not given, the note corresponding to the current buffer is opened.
53
53
54
-
-`:ObsidianNew [TITLE]` to create a new note.
54
+
-`:Obsidian new [TITLE]` to create a new note.
55
55
This command has one optional argument: the title of the new note.
56
56
57
-
-`:ObsidianQuickSwitch` to quickly switch to (or open) another note in your vault, searching by its name using [ripgrep](https://github.com/BurntSushi/ripgrep) with your preferred picker (see [plugin dependencies](#plugin-dependencies) below).
57
+
-`:Obsidian quick_switch` to quickly switch to (or open) another note in your vault, searching by its name using [ripgrep](https://github.com/BurntSushi/ripgrep) with your preferred picker (see [plugin dependencies](#plugin-dependencies) below).
58
58
59
-
-`:ObsidianFollowLink [vsplit|hsplit]` to follow a note reference under the cursor, optionally opening it in a vertical or horizontal split.
59
+
-`:Obsidian follow_link [vsplit|hsplit]` to follow a note reference under the cursor, optionally opening it in a vertical or horizontal split.
60
60
61
-
-`:ObsidianBacklinks` for getting a picker list of references to the current buffer.
61
+
-`:Obsidian backlinks` for getting a picker list of references to the current buffer.
62
62
63
-
-`:ObsidianTags [TAG ...]` for getting a picker list of all occurrences of the given tags.
63
+
-`:Obsidian tags [TAG ...]` for getting a picker list of all occurrences of the given tags.
64
64
65
-
-`:ObsidianToday [OFFSET]` to open/create a new daily note. This command also takes an optional offset in days, e.g. use `:ObsidianToday -1` to go to yesterday's note. Unlike `:ObsidianYesterday` and `:ObsidianTomorrow` this command does not differentiate between weekdays and weekends.
65
+
-`:Obsidian today [OFFSET]` to open/create a new daily note. This command also takes an optional offset in days, e.g. use `:Obsidian today -1` to go to yesterday's note. Unlike `:Obsidian yesterday` and `:Obsidian tomorrow` this command does not differentiate between weekdays and weekends.
66
66
67
-
-`:ObsidianYesterday` to open/create the daily note for the previous working day.
67
+
-`:Obsidian yesterday` to open/create the daily note for the previous working day.
68
68
69
-
-`:ObsidianTomorrow` to open/create the daily note for the next working day.
69
+
-`:Obsidian tomorrow` to open/create the daily note for the next working day.
70
70
71
-
-`:ObsidianDailies [OFFSET ...]` to open a picker list of daily notes. For example, `:ObsidianDailies -2 1` to list daily notes from 2 days ago until tomorrow.
71
+
-`:Obsidian dailies [OFFSET ...]` to open a picker list of daily notes. For example, `:Obsidian dailies -2 1` to list daily notes from 2 days ago until tomorrow.
72
72
73
-
-`:ObsidianTemplate [NAME]` to insert a template from the templates folder, selecting from a list using your preferred picker. See ["using templates"](#using-templates) for more information.
73
+
-`:Obsidian template [NAME]` to insert a template from the templates folder, selecting from a list using your preferred picker. See ["using templates"](#using-templates) for more information.
74
74
75
-
-`:ObsidianSearch [QUERY]` to search for (or create) notes in your vault using `ripgrep` with your preferred picker.
75
+
-`:Obsidian search [QUERY]` to search for (or create) notes in your vault using `ripgrep` with your preferred picker.
76
76
77
-
-`:ObsidianLink [QUERY]` to link an inline visual selection of text to a note.
77
+
-`:Obsidian link [QUERY]` to link an inline visual selection of text to a note.
78
78
This command has one optional argument: a query that will be used to resolve the note by ID, path, or alias. If not given, the selected text will be used as the query.
79
79
80
-
-`:ObsidianLinkNew [TITLE]` to create a new note and link it to an inline visual selection of text.
80
+
-`:Obsidian linknew [TITLE]` to create a new note and link it to an inline visual selection of text.
81
81
This command has one optional argument: the title of the new note. If not given, the selected text will be used as the title.
82
82
83
-
-`:ObsidianLinks` to collect all links within the current buffer into a picker window.
83
+
-`:Obsidian links` to collect all links within the current buffer into a picker window.
84
84
85
-
-`:ObsidianExtractNote [TITLE]` to extract the visually selected text into a new note and link to it.
85
+
-`:Obsidian extract_note [TITLE]` to extract the visually selected text into a new note and link to it.
86
86
87
-
-`:ObsidianWorkspace [NAME]` to switch to another workspace.
87
+
-`:Obsidian workspace [NAME]` to switch to another workspace.
88
88
89
-
-`:ObsidianPasteImg [IMGNAME]` to paste an image from the clipboard into the note at the cursor position by saving it to the vault and adding a markdown image link. You can configure the default folder to save images to with the `attachments.img_folder` option.
89
+
-`:Obsidian paste_img [IMGNAME]` to paste an image from the clipboard into the note at the cursor position by saving it to the vault and adding a markdown image link. You can configure the default folder to save images to with the `attachments.img_folder` option.
90
90
91
-
-`:ObsidianRename [NEWNAME] [--dry-run]` to rename the note of the current buffer or reference under the cursor, updating all backlinks across the vault. Since this command is still relatively new and could potentially write a lot of changes to your vault, I highly recommend committing the current state of your vault (if you're using version control) before running it, or doing a dry-run first by appending "--dry-run" to the command, e.g. `:ObsidianRename new-id --dry-run`.
91
+
-`:Obsidian rename [NEWNAME] [--dry-run]` to rename the note of the current buffer or reference under the cursor, updating all backlinks across the vault. Since this command is still relatively new and could potentially write a lot of changes to your vault, I highly recommend committing the current state of your vault (if you're using version control) before running it, or doing a dry-run first by appending "--dry-run" to the command, e.g. `:Obsidian rename new-id --dry-run`.
92
92
93
-
-`:ObsidianToggleCheckbox` to cycle through checkbox options.
93
+
-`:Obsidian toggle_checkbox` to cycle through checkbox options.
94
94
95
-
-`:ObsidianNewFromTemplate [TITLE]` to create a new note from a template in the templates folder. Selecting from a list using your preferred picker.
95
+
-`:Obsidian new_from_template [TITLE]` to create a new note from a template in the templates folder. Selecting from a list using your preferred picker.
96
96
This command has one optional argument: the title of the new note.
97
97
98
-
-`:ObsidianTOC` to load the table of contents of the current note into a picker list.
98
+
-`:Obsidian toc` to load the table of contents of the current note into a picker list.
99
99
100
100
### Demo
101
101
@@ -111,11 +111,11 @@ The fork aims to stay close to the original, but fix bugs, include and merge use
111
111
112
112
Specific operating systems also require additional dependencies in order to use all of obsidian.nvim's functionality:
113
113
114
-
-**Windows WSL** users need [`wsl-open`](https://gitlab.com/4U6U57/wsl-open) for the `:ObsidianOpen` command.
115
-
-**MacOS** users need [`pngpaste`](https://github.com/jcsalterego/pngpaste) (`brew install pngpaste`) for the `:ObsidianPasteImg` command.
116
-
-**Linux** users need xclip (X11) or wl-clipboard (Wayland) for the `:ObsidianPasteImg` command.
114
+
-**Windows WSL** users need [`wsl-open`](https://gitlab.com/4U6U57/wsl-open) for the `:Obsidian open` command.
115
+
-**MacOS** users need [`pngpaste`](https://github.com/jcsalterego/pngpaste) (`brew install pngpaste`) for the `:Obsidian pasteimg` command.
116
+
-**Linux** users need xclip (X11) or wl-clipboard (Wayland) for the `:Obsidian pasteimg` command.
117
117
118
-
Search functionality (e.g. via the `:ObsidianSearch` and `:ObsidianQuickSwitch` commands) also requires a picker such [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) (see [plugin dependencies](#plugin-dependencies) below).
118
+
Search functionality (e.g. via the `:Obsidian search` and `:Obsidian quickswitch` commands) also requires a picker such [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) (see [plugin dependencies](#plugin-dependencies) below).
119
119
120
120
### Install and configure
121
121
@@ -424,7 +424,7 @@ This is a complete list of all of the options that can be passed to `require("ob
424
424
substitutions= {},
425
425
},
426
426
427
-
-- Optional, by default when you use `:ObsidianFollowLink` on a link to an external
427
+
-- Optional, by default when you use `:Obsidian followlink` on a link to an external
428
428
-- URL it will be ignored but you can customize this behavior here.
429
429
---@paramurlstring
430
430
follow_url_func=function(url)
@@ -435,7 +435,7 @@ This is a complete list of all of the options that can be passed to `require("ob
435
435
-- vim.ui.open(url) -- need Neovim 0.10.0+
436
436
end,
437
437
438
-
-- Optional, by default when you use `:ObsidianFollowLink` on a link to an image
438
+
-- Optional, by default when you use `:Obsidian followlink` on a link to an image
439
439
-- file it will be ignored but you can customize this behavior here.
440
440
---@paramimgstring
441
441
follow_img_func=function(img)
@@ -448,7 +448,7 @@ This is a complete list of all of the options that can be passed to `require("ob
0 commit comments