Skip to content

Conversation

@alfarelcynthesis
Copy link
Contributor

@alfarelcynthesis alfarelcynthesis commented Nov 5, 2025

The current version of obsidian.nvim hasn't been updated in more than a year, isn't maintained, and hasn't kept up with new plugin compatibility.

This fork is the most popular one I found, is actively maintained, and has some nice newer features.

This PR converts nvf to use the fork instead, documenting the changes, which changes are immediately breaking (if you use the relevant options), and which options are still supported but deprecated.

I also removed some stale documentation and default configuration that didn't provide anything of value.
The configuration options are now entirely freeform.

A couple useful and suggested integrations were added, which I believe follow in the spirit of the project, automatically configuring stuff that is obvious given the context of the greater configuration.

Currently based on #1299, since this adds to the release file that PR creates.
I'll rebase as necessary when that PR is updated and when it is merged into main.
Other than that, this PR is ready for review, but I'm leaving it as a draft
until then to prevent the rebase from dismissing things.

Remaining Work

  • working plugin
  • healthcheck fails here now, but not when I was doing this as a pluginOverride (Obsidian.opts warning is also new)
    • Seems to work fine if I don't use noBuildPlug or buildPlug.
      Is now set up as an exception in the wrapper setup.
    • it broke again??
      • i fixed it. it's very fragile.
  • breaking change notes for removed nvf options, but not upstream deprecations
    • only included a breaking change for the commonly-used dir option, to make it more visible, including how to fix it
  • test the folding tip
  • check docs rendering, fix up, build packages
  • remaining testing
  • rebase on docs/manual: move v0.9 entries to the correct file; format #1299, since this touches a few documentation files and this isn't urgent enough that it can't wait for after that PR

Sanity Checking

Note that nix flake check hasn't been changed to remove the broken markdown formatting check yet, so that will fail, but is otherwise clean.

  • I have updated the changelog as per my changes
  • I have tested, and self-reviewed my code
    • Tested with and without blink.cmp and nvim-cmp (but not with both).
    • Tested with and without snacks.picker, mini.pick, telescope.nvim, and fzf-lua.
      • Only fzf-lua gets detected by the :checkhealth.
    • Tested with and without snacks.image and related configuration.
  • My changes fit guidelines found in hacking nvf
  • Style and consistency
    • I ran Alejandra to format my code (nix fmt)
    • My code conforms to the editorconfig configuration of the project
    • My changes are consistent with the rest of the codebase
  • If new changes are particularly complex:
    • My code includes comments in particularly complex areas
    • I have added a section in the manual
    • (For breaking changes) I have included a migration guide
  • Package(s) built:
    • .#nix (default package)
      • this doesn't change anything for either of the default configurations
    • .#maximal
    • .#docs-html (manual, must build)
    • .#docs-linkcheck (optional, please build if adding links)
      • Unrelated errors.
  • Tested on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin

Add a 👍 reaction to pull requests you find important.

@github-actions
Copy link

github-actions bot commented Nov 5, 2025

🚀 Live preview deployed from 17c17cf

View it here:

Debug Information

Triggered by: alfarelcynthesis

HEAD at: obsidian-nvim-fork

Reruns: 1845

@github-actions github-actions bot deleted the obsidian-nvim-fork branch December 15, 2025 04:44
@alfarelcynthesis alfarelcynthesis restored the obsidian-nvim-fork branch December 17, 2025 21:47
github-actions bot pushed a commit that referenced this pull request Dec 17, 2025
@alfarelcynthesis alfarelcynthesis force-pushed the obsidian-nvim-fork branch 2 times, most recently from b374a5a to 6688ef2 Compare December 17, 2025 21:54
github-actions bot pushed a commit that referenced this pull request Dec 17, 2025
@alfarelcynthesis alfarelcynthesis changed the base branch from v0.8 to main December 17, 2025 22:04
github-actions bot pushed a commit that referenced this pull request Dec 20, 2025
@alfarelcynthesis alfarelcynthesis force-pushed the obsidian-nvim-fork branch 3 times, most recently from 8540844 to c482a4f Compare December 20, 2025 07:38
github-actions bot pushed a commit that referenced this pull request Dec 20, 2025
@alfarelcynthesis
Copy link
Contributor Author

@NotAShelf not urgent but the docs preview doesn't seem to update the option descriptions or the module docs I've changed/removed.

I can just build stuff locally, but I figured I should let you know.

github-actions bot pushed a commit that referenced this pull request Dec 20, 2025
github-actions bot pushed a commit that referenced this pull request Dec 25, 2025
@NotAShelf
Copy link
Owner

@NotAShelf not urgent but the docs preview doesn't seem to update the option descriptions or the module docs I've changed/removed.

I can just build stuff locally, but I figured I should let you know.

I'm aware, but I haven't had time to investigate the issue. Especially given how truly archaic GHA truly is. I'm hoping to look into it, but I'm currently unavailable due to a variety of irl issues. This is obviously not a blocker, so I'll try to investigate whenever I have more time. If you wish to make sure this is not forgotten, feel free to create an issue :)

@alfarelcynthesis
Copy link
Contributor Author

@NotAShelf not urgent but the docs preview doesn't seem to update the option descriptions or the module docs I've changed/removed.
I can just build stuff locally, but I figured I should let you know.

I'm aware, but I haven't had time to investigate the issue. Especially given how truly archaic GHA truly is. I'm hoping to look into it, but I'm currently unavailable due to a variety of irl issues. This is obviously not a blocker, so I'll try to investigate whenever I have more time. If you wish to make sure this is not forgotten, feel free to create an issue :)

Definitely focus on other more important things, yeah.

Honestly being able to check before pushing is more my style.
I won't bother making an issue, if it gets forgotten so be it.

github-actions bot pushed a commit that referenced this pull request Dec 28, 2025
github-actions bot pushed a commit that referenced this pull request Jan 3, 2026
github-actions bot pushed a commit that referenced this pull request Jan 7, 2026
@alfarelcynthesis alfarelcynthesis marked this pull request as ready for review January 7, 2026 01:00
github-actions bot pushed a commit that referenced this pull request Jan 7, 2026
github-actions bot pushed a commit that referenced this pull request Jan 7, 2026
Stable releases are regular and compatible with the latest packaged
nvim versions from nixpkgs.
Obsidian essentially requires direct configuration, is not for a generic config example config.
It isn't enabled now, so removing it should be fine.
github-actions bot pushed a commit that referenced this pull request Jan 8, 2026
Copy link
Collaborator

@Soliprem Soliprem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI failures seem related to another change. LGTM

# It doesn't detect/choose this.
# Some pickers and completion plugins don't get detected correctly by the checkhealth, but they all work.
# Values taken from the [config's](https://github.com/obsidian-nvim/obsidian.nvim/blob/main/lua/obsidian/config/init.lua) valid ones.
picker.name =
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really hate this but cannot think of a single better way of doing it. Curse the Nix language...

@NotAShelf NotAShelf merged commit 328e096 into NotAShelf:main Jan 8, 2026
12 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants