obsidian.nvim

What's new

Fixed ✅

• Fixed os selection in ObsidianOpen command.

Commits

7283ccf chore(release): bump version to v3.5.2 for release
4c19119 fix: os select bug in open command (#435)

What's new

Minor internal improvements.

Commits

4eb4438 chore(release): bump version to v3.5.1 for release
7ac7da2 chore(docs): auto generate docs
3edeaa9 Minor improvements to Path usage (#434)
6272434 FreeBSD support for ObsidianOpen (#433)

What's new

Added 🎉

• Added CI testing for Windows.

Changed ⚠️

• (internal) Replaced all uses of plenary.path with a custom obsidian.path class that stays more true to the Python pathlib API and should be more reliable across operating systems.

Fixed ✅

• If you have new_notes_location="current_dir" but you're not inside of a vault, the new note will be created in your vault instead of the current (buffer) directory.
• Fixed a regression where note titles were not considered for autocomplete when the title was not part of the frontmatter (only an H1 header).
• Escaped tags (e.g. \#notatag) will no longer come up in tag searches.

Commits

a53ed63 chore(release): bump version to v3.5.0 for release
9d38ca6 Make sure escaped tags don't show up in search (#429)
3e5b312 Avoid vim.fs.joinpath for compat with nvim 0.9.* (#432)
cba0830 chore(docs): auto generate docs
78da25a Expand tests, remove option to change YAML parser (#431)
21aff5f chore(docs): auto generate docs
b14b1b1 Add Path to doc TOC
62077b5 chore(docs): auto generate docs
c561bbf Expand path functionality (#430)
c7e8bd9 chore(docs): auto generate docs
070af8a Replace plenary.Path with obsidian.Path (#425)
cf774a7 Use note titles for completions
dd48361 Making skip dirs more robust
d8d160d Clean up debug cmd more
9b3e6f6 Fix another bug with :ObsidianDebug
f65b087 Fix bug with :ObsidianDebug command
42ec60e Ensure new notes always created inside vault
a7065a1 chore(docs): auto generate docs
c870f8b clean up readme

What's new

Fixed ✅

• Ensure old buffer is removed when renaming current note.

Commits

59d274b chore(release): bump version to v3.4.1 for release
8ab501e chore(deps): bump JohnnyMorganz/stylua-action from 3 to 4 (#393)
290fd63 chore(deps): bump actions/cache from 3 to 4 (#339)
1604e04 Ensure old buffer removed when renaming cur note
3618dab update bug template
8784ad9 pull before release

What's new

Added 🎉

• Added client methods Client:find_backlinks() and Client:find_backlinks_async().
• Added client method Client:open_note() for open a note in a buffer.

Changed ⚠️

• :ObsidianBacklinks and :ObsidianTags now open your preferred picker instead of a separate buffer.
• Improved cmp_obsidian doc/preview text.

Fixed ✅

• Fixed :ObsidianExtractNote when usual visual line selection ("V").
• Fixed "hsplit" open strategy.

Commits

be82bc7 chore(release): bump version to v3.4.0 for release
977224b Refactor config normalization
d0a2e03 chore(docs): auto generate docs
392e322 Add client method Client:open_note()
ca48902 Fix "hsplit" open strategy
e08105a chore(docs): auto generate docs
38879af Improve cmp doc/preview text
a2dcb37 chore(docs): auto generate docs
7bee190 Replace loclist with picker for backlinks and tags (#415)
23e987d Fix :ObsidianExtractNote in "V" mode
f7658a4 Minor update to how templates are inserted
6cdef0c Update command descriptions
1939914 improve picker API
066b2e4 chore(docs): auto generate docs
1c942af Fix workspace test
23c935d Add client methods for collecting backlinks

What's new

Fixed ✅

• Fixed inserting templates when the templates directory structure is nested.

Commits

b5945fb chore(release): bump version to v3.3.1 for release
a83a958 Fix inserting templates from nested directory
cdbc615 Add more debug info
26f3d3e Update bug template
8635361 Add more debugging info

What's new

Added 🎉

• Support for file:/ and file:/// Urls.
• Added configuration options wiki_link_func and markdown_link_func for customizing how links are formatted.

Fixed ✅

• Urls ending in / were not detected.
• Fixed small bug with toggle checkbox mapping where lines that started with a wiki link or md link were misclassified.

Changed ⚠️

• Config options completion.prepend_note_id, completion.prepend_note_path, and completion.use_path_only are now deprecated. Please use wiki_link_func and markdown_link_func instead.
• Moved configuration option completion.preferred_link_style to top-level preferred_link_style.
• Moved configuration option completion.new_notes_location to top-level new_notes_location.

Commits

e8c9f09 chore(release): bump version to v3.3.0 for release
1a1cd33 chore(docs): auto generate docs
9603acc Fix doc
7345b25 chore(docs): auto generate docs
f753d0d Move completion.new_notes_location to top-level
0285e27 chore(docs): auto generate docs
729eb73 Move completion.preferred_link_style to top-level
de49450 chore(docs): auto generate docs
08607b0 Add customization of wiki/markdown link format (#406)
94a8612 Fix bug with toggle checkbox
17032a8 Added support for file links (#402)
b8d0738 chore(docs): auto generate docs
c66b5da change defaults in README

What's new

Added 🎉

• Added :ObsidianLinks command.
• Added :ObsidianExtractNote command.

Fixed ✅

• Improved how we get visual selection for certain commands.

Commits

0a6739d chore(release): bump version to v3.2.0 for release
e6aaf12 chore(docs): auto generate docs
12c1386 Use our own function for finding parent directories (#400)
492f1a0 Add :ObsidianDebug command
48cc82e Another fix the visual selection
9e1b62a chore(docs): auto generate docs
03037bd Minor fix to :ObsidianExtractNote
e7857fe Update extmarks after inserting link
efcf086 chore(docs): auto generate docs
228bdbb Add ObsidianExtractNote command (#397)
ca6f49a chore(docs): auto generate docs
6026991 Fix type for opts arg in Client:format_link
919a243 Fix typo (#398)
0458e67 Remove old ui.tick field
68eb9a4 chore(docs): auto generate docs
dd73652 Merge pull request #396 from epwalsh/epwalsh/links

What's new

Added 🎉

• Added descriptions to all commands.

Changed ⚠️

• Major internal refactoring / improvements for how we integrate with pickers.
• Configuration option finder and finder_mappings have been consolidated into picker = { name: string, mappings: { ... } }.
• When :ObsidianWorkspace is called without any arguments, obsidian.nvim will open your picker to select a workspace to switch to.

Fixed ✅

• Resolve workspace path when behind symlinks.

Removed 👋

• Removed support for fzf.vim as a picker (fzf-lua is still supported).

Commits

06154ec chore(release): bump version to v3.1.0 for release
14889af Open picker when :ObsidianWorkspace called without arg
665c609 Add descriptions to commands
6e17c33 Resolve cwd behind symlinks
edba6fa Resolve workspace path behind symlink (#390)
06e62fd Allow picker.name to be nil
225453f make picker name robust to case
667ffd4 chore(docs): auto generate docs
82b5100 Refactor picker integrations, remove support for fzf.vim (#387)
e0a677b chore(docs): auto generate docs
73bde04 Rename finder -> picker

What's new

⚠️ POTENTIALLY BREAKING CHANGES! PLEASE READ BELOW ⚠️

Added 🎉

• Added support for "dynamic" workspaces where the workspace path field is a function instead of a string / Path. See PR #366.

Changed ⚠️

• Changed behavior of workspace detection. When you have multiple workspaces configured, obsidian.nvim will now automatically switch workspaces when you open a buffer in a different workspace. See PR #366.
• Various changes to the Workspace Lua API. See PR #366.
• Changed the behavior of the default frontmatter function so it no longer automatically adds the title of the note as an alias. See the note_frontmatter_func example in the README if you want the old behavior.

Removed 👋

• Removed configuration option detect_cwd. This wasn't well-defined before and is no longer relevant with the new workspace detection behavior. See PR #366.

Fixed ✅

• Fixed two bugs with creating new notes through :ObsidianFollowLink (and gf) where it wouldn't respect the completion.new_notes_location settings, and wouldn't respect paths in certain formats.

Commits

387f5cf chore(release): bump version to v3.0.0 for release
261e945 don't update buf lines when frontmatter hasn't changed
36a252b chore(docs): auto generate docs
43a5ee6 update section name
24d94cd chore(docs): auto generate docs
7abba86 Update documentation on workspaces
dcf2eea chore(docs): auto generate docs
1361265 Lock workspace after manual switch
a9e7fde Fix bugs with new note creation (#384)
649e559 chore(docs): auto generate docs
f6e3e65 Don't automatically insert title as an alias
6b9f27f chore(docs): auto generate docs
2dedce5 update wording in readme
1691edb chore(docs): auto generate docs
7c1ff20 Update workspace API and detection behavior, add support for "dynamic" workspaces (#366)

What's new

Added 🎉

• Added note field Note.title to provide more useful info for note_frontmatter_func.
• Added client method Client:format_link() for creating markdown / wiki links.
• Added telescope action to insert a note link in certain finder scenarios.

Fixed ✅

• Fixed parsing header with trailing whitespace (https://github.com/epwalsh/obsidian.nvim/issues/341#issuecomment-1925445271).

Commits

32de09d chore(release): bump version to v2.10.0 for release
9a737a4 chore(docs): auto generate docs
072e9ca Add title field to Note class (#375)
8db7c0c chore(docs): auto generate docs
cf7516d insert_link action (#367)
d1c8162 Fix parsing header with trailing whitespace
e35acb8 chore(docs): auto generate docs
27bc40c Add client method Client:format_link().

What's new

Added 🎉

• Added configuration option image_name_func: (fun(): string)|? for customizing the default image name/prefix when pasting images via :ObsidianPasteImg.
• Added client method Client:current_note() to get the note corresponding to the current buffer.
• Added client method Client:list_tags() for listing all tags in the vault, along with async version Client:list_tags_async(callback: fun(tags: string[])).
• Added note method Note.add_field(key: string, value: any) to add/update an additional field in the frontmatter.
• Added note method Note.get_field(key: string).
• Added note method Note.save_to_buffer(bufnr: integer|?, frontmatter: table|?) for saving the frontmatter to a buffer.

Changed ⚠️

• :ObsidianTags command can take a visual selection or look for a tag under the cursor instead of explicitly provided arguments.

Commits

8b10f0c chore(release): bump version to v2.9.0 for release
c83f9cb Minor fixes + clean up
a20754e chore(docs): auto generate docs
2cb2446 Update demo
426e1e0 chore(docs): auto generate docs
2e17d08 Update screenshots
31e7cfc chore(docs): auto generate docs
5ee32ec update readme
35afa8d chore(docs): auto generate docs
5fecc73 Open finder with all tags when no tag supplied to :ObsidianTags
97f0cfe feat(toggle_checkbox): transform non-checkbox line into a checkbox (#363)
d9be302 Allow viz selection or cursor location with :ObsidianTags command
6b2e0f5 Fix type of note_id_func
a0fe470 chore(docs): auto generate docs
a6596be Make tag completion fuzzy
8d7842e chore(docs): auto generate docs
210874b Merge pull request #362 from epwalsh/epwalsh/list-tags
8ea05a3 Add description to toggle_checkbox keymap opts (#358)
f5e560b chore(docs): auto generate docs
ae39ba3 Add option to customize default image name
b6eba26 Improve foldtext in location list
d1782e4 chore(docs): auto generate docs
7e3ae5a Add method Note:get_field(key: string)
6231702 Make URL regex more robust
1a14849 chore(docs): auto generate docs
6094a23 fix type
89813ca chore(docs): auto generate docs
b0fd116 Add new client and note methods (#351)
64de405 fix(open): linux error spawning new obsidian process (#346)

What's new

Added 🎉

• Added :ObsidianTags command.

Changed ⚠️

• Changed API of client methods Client:find_tags() and Client:find_tags_async(). The return value (or value passed to the callback) is now a list of objects representing the location of tags found. These objects have the following fields: tag: string, path: string|Path, line: integer.

Fixed ✅

• Fixed a YAML parsing issue with unquoted URLs in an array item.
• Fixed an issue on Windows when cloning a template into a new note. The root cause was this bug in plenary: https://github.com/nvim-lua/plenary.nvim/issues/489. We've added a work-around.

Commits

b101ad8 chore(release): bump version to v2.8.0 for release
f5176ea Add work-around for plenary path bug on Windows (#349)
217f7c7 Fix YAML parsing issues with unquoted URLs (#348)
194f9fc chore(docs): auto generate docs
c8b7d91 Add :ObsidianTags command (#345)
5f469fa Separate quickfix win logic from backlinks
3b0020d chore(docs): auto generate docs
fecc91f Improve API of Client:find_tags() and find_tags_async() (#344)

What's new

Fixed ✅

• Fixed powershell command for :ObsidianPasteImg in wsl
• Fixed bug with YAML parser that led to incorrectly parsing double-quoted strings with escaped quotes inside.

Commits

f604a30 chore(release): bump version to v2.7.1 for release
59bc77b handle frontmatter parsing failures better
2c751d8 fix powershell command for :ObsidianPasteImg on WSL (#340)
3b4c672 Fix bug with YAML parser
1c88899 chore(docs): auto generate docs
f293f7d Fix typo in README.md
a6b03f0 update release notes

What's new

Fixed ✅

• Fixed fzf-lua implementation of insert template and linking.
• Fixed minor bug with cmp_obsidian_new.

Added 🎉

• Added support for parsing single aliases specified as a string, not a list, in frontmatter. E.g. aliases: foo as opposed to aliases: [foo]. Though when the frontmatter is saved it will always be saved as a YAML list, so aliases: foo gets saved as aliases: [foo] (or equivalent).
• Added Client methods Client:apply_async() and Client:apply_async_raw().

Commits

c3e88c5 chore(docs): auto generate docs
cd0f9d3 add emphasis to readme
bb2ff83 chore(docs): auto generate docs
51ca4dd Add Client:apply_async() and :apply_async_raw() (#336)
50b67e2 fix minor bug with cmp_obsidian_new
bf8083f Add support for single aliases as string
342af36 minor refactor
abf772d Fix template usage for fzf_lua (#326)

What's new

Added 🎉

• Added extmarks that conceal "-", "*", or "+" with "•" by default. This can turned off by setting .ui.bullets to nil in your config.

Fixed ✅

• Fixed bug with resolving the vault-relative path when the vault is behind a symlink.
• Fixed bug with completion after changing workspaces.

Commits

8ffe0e4 Fix bug with completion after changing workspaces (#328)
02cb29f error when template file not found
aaba6eb Bullet marks for lists marked up with + or * (#324)
3160fe5 chore(docs): auto generate docs
c2a8ae4 Clarify that the example config is not default
86caccd Add note about how to disable UI features in warning
0bc8f68 Fix bug with Client:vault_relative_path (#322)
6b232d4 chore(docs): auto generate docs
5ac4951 add bullet marks (#320)

What's new

Changed ⚠️

• Creating new notes via :ObsidianFollowLink now matches the behavior of :ObsidianLinkNew, where the new note will be placed in the same directory as the current buffer note. This doesn't affect you if you use a flat directory structure for all of your notes.
• :ObsidianRename will prompt for the new title/ID/path if not given as an argument.

Added 🎉

• :ObsidianFollowLink now takes an optional "open strategy" argument. For example :ObsidianFollowLink vsplit or :ObsidianFollowLink vsp opens the note in a vertical split.
• Added client method Client:command(...) for running commands directly. For example: :lua require("obsidian").get_client():command("ObsidianNew", { args = "Foo" }).
• Added vim docs for the Lua API. See :help obsidian-api or :help obsidian.Client.
• Added the option to create notes with a mapping from the telescope finder with :ObsidianQuickSwitch and :ObsidianSearch.
• Added client methods Client:find_files() and Client:find_files_async() for finding non-markdown files in the vault.

Fixed ✅

• Fixed bug with YAML encoder where strings with a colon followed by whitespace were not quoted.
• Parent directories are created when using a template (for example, for daily notes).
• Fixed bug with finder/picker in :ObsidianLink when current working directory is not vault root.
• :ObsidianFollowLink will now work when the link contains spaces encoded with "%20" (as they are in URLs) to match the behavior of the Obsidian app.

Commits

9a6eb2a Allow spaces encoded with '%20' in links (#317)
bbe8ceb chore(docs): auto generate docs
f9a3f03 add warning about viewing readme from main
6cff32e Fix bug with picker in :ObsidianLink (#316)
a11a754 chore(docs): auto generate docs
eae7bfd Add Client:find_files(_async) method (#312)
3c99b2c prompt for new title/id/path with ObsidianRename
1e120b7 fix(templates): create parent directories (#311)
568f729 chore(docs): auto generate docs
0c0ef84 feat: create new note on C-x with telescope (#296)
2d02fe9 Fix bug with YAML encoder (#309)
4c3f8c1 refactor(ui.lua): only notify the user for conceallevel in markdown files once (#307)
e9a8fd0 fix logging of stderr
073c446 default to "yes" with confirmation prompt when nothing is entered (#306)
2378382 Fix: make :ObsidianFollowLink match behavior of :ObsidianLinkNew with new notes (#303)
5074f5a Fix docs CI on PRs
2fc107e clean up again
2a067ee keep file from being generated
bbdce9d chore(docs): auto generate docs
467cfe7 clean up
673cd6c chore(docs): auto generate docs
dfbd15c ensure _neovim not committed
e14df3a Integrate mini.doc to generate Lua API docs (#300)
2b8e8d1 chore(docs): auto generate docs
72d1ea1 Add warning when 'conceallevel' not set correctly
f8b6bb9 make language server happy
9839def Add client method for running commands directly (#298)
806e026 chore(docs): auto generate docs
44d2b97 Add optional open strategy arg to :ObsidianFollowLink
fe20be1 chore(docs): auto generate docs

What's new

Fixed ✅

• Removed some errant print statements.

Commits

fe78b91 remove some errant print statements

What's new

Fixed ✅

• Fixed bug with Client:resolve_note() that missed checking the parent directory of the current buffer.
• Made gathering backlinks work with links of different forms, like Markdown or Wiki with just an alias.

Commits

827668e Make gathering backlinks more robust
0f7517b fix big with Client:resolve_note()
fa201a5 chore(docs): auto generate docs
fd5322d Link to @omerxx's YouTube video in README

What's new

Fixed ✅

• Fixed a bug on Linux where we call a restricted function in an async context.
• Fixed bug with resolving relative path in vault when path is already relative.

Commits

8abae3c Fix LUV errors for Linux (#290)
878f80b fix bug with resolving relative paths (#291)