fix(obsidian-nvim): added obsidian.nvim config and changed the readme

[mortang2410]

As requested from #309. We need this config to follow links to other markdown files. Please check if anything is amiss.

Edit: I see the review checklist asks for "Proper usage of opts table rather than setting things up with the config function." I'm not sure if that is satisfied here.

[github-actions]

Review Checklist

Does this PR follow the [Contribution Guidelines](development guidelines)? Following is a partial checklist:

Proper conventional commit scoping:

• If you are adding a new plugin, the scope would be the name of the category it is being added into. ex. feat(utility): added noice.nvim plugin

• If you are modifying a pre-existing plugin or pack, the scope would be the name of the plugin folder. ex. fix(noice-nvim): fix LSP handler error

• Pull request title has the appropriate conventional commit type and scope where the scope is the name of the pre-existing directory in the project as described above

• README is properly formatted and uses fenced in links with <url> unless they are inside a [title](url)

• Proper usage of opts table rather than setting things up with the config function.

[owittek]

Wouldn't it be enough to just add your 2 changes to the init.lua instead of pasting the entire default config as you're not changing the defaults?

[mortang2410]

just add your 2 changes

Setting up the gf keybinding, for instance, to follow links is done in the config, so we have to copy paste some of it. I also disabled a few things like the notes, daily_notes, tabular, vim-markdown (as we already use treesitter), new note ID (it would create new notes upon the slightest mistypes etc.). I think those are sane defaults but please feel free to discuss.

[owittek]

Pardon me then, I came from the issue and the first part as well as the comments seem to be directly taken from the obsidian README.

But my point stands, it's unclear for me what parts deviate from the default config if you also put in all the defaults and leave all the comments in.

Also we'd have to handle line 91-95 in a way that is OS agnostic. For that we'd have to use a function for opts instead.

Lastly we should setup the key bind in a different way than to place it in the config function for various reasons.

[mortang2410]

Also we'd have to handle line 91-95 in a way that is OS agnostic. For that we'd have to use a function for opts instead.
Lastly we should setup the key bind in a different way than to place it in the config function for various reasons.

I agree with both of these points. I admit, however, that I am unfamiliar with how astronvim should handle both of these. If you have solutions for them, please share.

[owittek]

I can refactor opts when I got time and with the key bind part perhaps @RayJameson could help since he did that kind of stuff for harpoon before.

[RayJameson]

Shouldn't it work with the keys property in the plugin setup? I did that thing for Harpoon because there is a top-level empty mapping with a description, that shows in <leader> which-key where are also other nested keymaps, so I wanted the Harpoon keymaps group to align with others, otherwise, I would stick to using keys

[owittek]

Hmm there's still an issue with the setup handler in my code. Testing right now...

[owittek]

I like my own changes, soo ...

[Uzaaft]

@owittek Added a suggestion for windows support as well.

[owittek]

the pipeline does not like us

[Uzaaft]

@owittek Apparently utils.system_open should be enough

[mehalter]

@owittek

Resolved

Outdated

[mehalter]

LGTM