Images - obsidian-nvim/obsidian.nvim GitHub Wiki

Viewing

The only image viewing backend that is well tested and supported is snacks.image, and for extra info there's work being done that will give neovim an native API rendering images, so eventually we will just move to that.

For proper image path resolving, add the following snippet to your snacks config, it will only effect markdown files in your vault:

(API could could change in the future)

require("snacks").setup({
   image = {
      resolve = function(path, src)
         if require("obsidian.api").path_is_note(path) then
            return require("obsidian.api").resolve_image_path(src)
         end
      end,
   },
})

Then you are good to go.

Change image save location

Option for image attachment location is opts.attachments.img_folder

1. for vault root, set it to /.
2. for fixed folder, set it to /folder-name.
3. for same folder as current file, set it to ./
4. for sub folder in current folder, set it to ./folder-name

Change insert text

The default opts.image_text_func is trying to be 100% obsidian compatible, and changes with the opts.preferred_link_style.

See the implementation in builtins.lua.

You can override the default behavior, for example to always use markdown use the base name as the markdown display text, like:

require("obsidian").setup({
   attachments = {
      img_text_func = function(path)
         local name = vim.fs.basename(tostring(path))
         local encoded_name = require("obsidian.util").urlencode(name)
         return string.format("![%s](%s)", name, encoded_name)
      end,
   },
})

The general principle to keep in mind is you want to use the encoded base name for compatibility for snacks.nvim and obsidian app.