Skip to content

Commit 50242f3

Browse files
authored
doc fixes (#675)
1 parent b92e75b commit 50242f3

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,10 @@ return {
129129
-- Replace the above line with this if you only want to load obsidian.nvim for markdown files in your vault:
130130
-- event = {
131131
-- -- If you want to use the home shortcut '~' here you need to call 'vim.fn.expand'.
132-
-- -- E.g. "BufReadPre " .. vim.fn.expand "~" .. "/my-vault/**.md"
133-
-- "BufReadPre path/to/my-vault/**.md",
134-
-- "BufNewFile path/to/my-vault/**.md",
132+
-- -- E.g. "BufReadPre " .. vim.fn.expand "~" .. "/my-vault/*.md"
133+
-- -- refer to `:h file-pattern` for more examples
134+
-- "BufReadPre path/to/my-vault/*.md",
135+
-- "BufNewFile path/to/my-vault/*.md",
135136
-- },
136137
dependencies = {
137138
-- Required.
@@ -391,12 +392,13 @@ This is a complete list of all of the options that can be passed to `require("ob
391392
vim.fn.jobstart({"open", url}) -- Mac OS
392393
-- vim.fn.jobstart({"xdg-open", url}) -- linux
393394
-- vim.cmd(':silent exec "!start ' .. url .. '"') -- Windows
395+
-- vim.ui.open(url) -- need Neovim 0.10.0+
394396
end,
395397

396398
-- Optional, by default when you use `:ObsidianFollowLink` on a link to an image
397399
-- file it will be ignored but you can customize this behavior here.
398400
---@param img string
399-
follow_url_func = function(img)
401+
follow_img_func = function(img)
400402
vim.fn.jobstart { "qlmanage", "-p", img } -- Mac OS quick look preview
401403
-- vim.fn.jobstart({"xdg-open", url}) -- linux
402404
-- vim.cmd(':silent exec "!start ' .. url .. '"') -- Windows

0 commit comments

Comments
 (0)