clutcher / bh

Issue tracker for Better Highlights Intellij IDEA plugin
6 stars 0 forks source link

Support for Dynamic Linking b/w Markdown and CodeFiles #124

Open prash-kr-meena opened 3 weeks ago

prash-kr-meena commented 3 weeks ago

Markdown is a great for documentation and we can link a file from markdown as well. But when we rename that code file which is referenced in markdown, that entry in markdown becomes stale and it never gets updated. There should have been a linking b/w the two but unfortunately there is not one.

Screenshot 2024-06-25 at 2 16 15 AM

above is one example where I was trying to basically list all the code files and directories (in a specific order). This becomes a challenge because once I list these files in the readme file, i would like to rename the files and remove the notion of numbers (ordering) from the file as that is not scalable with more number of questions.

but because when I rename all the entries in the readme file becomes stale, this is not at all feasible, because all the effort to document it will be lost.

I believe this is valid requirement but not sure if it is achievable with better-highlight in a way that is convienient as it is in markdown where it generates a link in the rendered view which directly open up the file.

PS: Great tool, thanks for building it 🙏🏼

clutcher commented 2 weeks ago

@prash-kr-meena This is an issue of markdown plugin, you can report it on Jebrains Youtrack. On plugin page - https://plugins.jetbrains.com/plugin/7793-markdown there is a link to issue tracker.

Better Highlights plugin uses comments for referencing, I can add file referencing in markdown comments(and it would be auto updated on file rename), but don't think that it will help with your use case.

Maybe, there is a sense for you to try another tool. I like Intellij, but markdown support is awful in it, so I'm mainly using Obsidian to work with markdown.