epwalsh / epwalsh/obsidian.nvim
Best practices for integration with mkdnflow.nvim et al
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 6.2k
- Forks
- 250
- PR merge metrics
- No merged PRs in 30d
Description
### 📚 The doc issue
A lot of us are using [Jake Vincent's excellent mkdnflow plugin](https://github.com/jakewvincent/mkdnflow.nvim).
I'd love to see some documentation on how to harmonize config between these two powerhouse Markdown plugins <3. There is some feature overlap, which means that a good config will have to e.g. harmonize the link following mechanism, the shortcuts, etc. but I'm not familiar enough yet with either plugin to propose my own solutions.
I'll work on it, but in the meantime, if anyone else has thoughts, I'd love to hear them!
Thanks for this beautiful nvim plugin <3
### Suggest a potential alternative/fix
_No response_
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the obsidian.nvim and mkdnflow.nvim configuration documentation, focusing on link following and shortcut overlap. Document the integration guidance and configuration considerations once the two plugins' overlapping behavior has been understood.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, neovim
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100