-
Notifications
You must be signed in to change notification settings - Fork 5
Description
Hi @daxcore ,
Thanks for creating this plugin. I'm a big fan of interactive graphs and really appreciate having this experience in MkDocs. I also appreciated the quick turnaround on the patch I submitted a couple of weeks ago.
My main concern is that the graph currently requires Obsidian-style wikilinks. Many users already have knowledge bases written in standard Markdown/HTML, which makes the plugin less plug-and-play for them. Teams also often prefer to stay close to plain Markdown/HTML for portability and tooling compatibility (easier tool switching, standard linters/parsers, etc.). In those cases, the current wikilink requirement may limit adoption.
Proposed Feature: Support Standard Markdown Links
I’d like to propose adding support for standard Markdown links as an alternative to Obsidian wikilinks.
The idea is to let users choose whether the graph is built from:
- standard Markdown links, or
- the existing Obsidian-style wikilink syntax (default).
For example:
plugins:
- obsidian-interactive-graph:
link_syntax: "markdown" # "obsidian" by defaultThis would make the plugin usable out-of-the-box for many more Markdown-based knowledge bases while preserving current behavior by default.
Roadmap / Plan
If you’re open to this direction, my plan would be:
- Add a test suite so future changes can be validated and don’t break existing behavior.
- Start implementing the new link_syntax option and Markdown-link parsing.
Important
Before I start on the implementation, I’d like to confirm that you’re okay with this approach, or if you have preferences on how you’d like this to be structured.
Other Options Considered
I looked at https://github.com/develmusa/mkdocs-network-graph-plugin as an alternative, but decided against it for now:
- It ships with a fixed JS asset, which makes customization harder. A key advantage of this plugin is that the JS asset is decoupled from the core logic, giving users the freedom to tailor their own graph behavior (which I need).
- Open PRs on that project haven’t been reviewed in over two months.
- This plugin has a lot more traction, so improvements here would likely help more users.
I have a few more ideas to extend the plugin’s usability, but I’d like to start with testing and link syntax flexibility first. Let me know if you have any thoughts/objections.