Skip to content

Commit

Permalink
chore: auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
epwalsh authored and github-actions[bot] committed Sep 25, 2023
1 parent 7a7942f commit 2be2759
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions doc/obsidian.txt
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,13 @@ This is a complete list of all of the options that can be passed to
-- Optional, key mappings.
mappings = {
-- Overrides the 'gf' mapping to work on markdown/wiki links within your vault.
["gf"] = require("obsidian.mapping").gf_passthrough(),
["gf"] = {
action = function()
return require("obsidian").util.gf_passthrough()
end,
opts = { noremap = false, expr = true, buffer = true },
},
},
},

-- Optional, customize how names/IDs for new notes are created.
Expand Down Expand Up @@ -356,7 +362,7 @@ Then make sure to comment out the `gf` keybinding in your obsidian.nvim config:

>lua
mappings = {
-- ["gf"] = require("obsidian.mapping").gf_passthrough(),
-- ["gf"] = ...
},
<

Expand All @@ -365,7 +371,12 @@ different key:

>lua
mappings = {
["fo"] = require("obsidian.mapping").gf_passthrough(),
["fo"] = {
action = function()
return require("obsidian").util.gf_passthrough()
end,
opts = { noremap = false, expr = true, buffer = true },
},
},
<

Expand Down

0 comments on commit 2be2759

Please sign in to comment.