Coder Social home page Coder Social logo

hadynz / obsidian-sidekick Goto Github PK

View Code? Open in Web Editor NEW
133.0 7.0 9.0 105 KB

A companion to identify hidden connections that match your tags and pages

JavaScript 2.84% Shell 0.20% CSS 2.43% TypeScript 94.53%
obsidian autcomplete autosuggestion connections

obsidian-sidekick's Introduction

Sidekick

CI/CD status GitHub release (latest by date)

An Obsidian plugin that auto-suggests new connections to make by underlining text that matches existing tags or links in your vault.

Support development: @hadynz on Twitter or Buy me a coffee

About Sidekick

Goals

  • Increase the number of connections between existing ideas
  • Unobtrusive and near real-time automatic suggestion of connections during editing

Preview

Kapture 2022-02-11 at 00 34 23

My other plugins

  • Kindle Highlights - sync your Kindle notes and highlights directly into your Obsidian vault

License

MIT

obsidian-sidekick's People

Contributors

hadynz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

obsidian-sidekick's Issues

Sidekick can add a quick on / off function.

Thank you for developing this plugin, which is very practical.
It is suggested that the author should add a quick open and close function to Sidekick.
Because it is always on, sometimes when this feature is not needed, it may affect the user experience.

Check for link before suggesting it

I love the plugin and the entire idea of it, but I find it to be quite annoying that it keeps suggesting the same link multiple times in the same file. It should first check if the link is already in the file before suggesting it.

do not work!

it seems it dose not work in obsidian v0.13.23

Bug: Obsidian crashes frequently when plugin is enabled

I've been experiencing frequent crashes of Obsidian after enabling this plugin. It happens after about 15 minutes of intensive use. I've never had a crash when the plugin is not enabled.

Licat mentions this can be a memory leak (I've not seen this clearly yet), or a misuse of nodejs/electron API

if it goes blank that means the renderer chromium process crashed

Significant lag when switching between notes

(Note: I have a rather large vault)
This plugin freezes Obsidian for about 10 seconds when switching between notes. Proof it is this plugin:
image

I cannot see in the console exactly how large the index is, but it seems to be around 10-20 thousand. Getting this index is apparently very expensive.

Cancel duplicate suggestion

Thanks for the developer's work. I think small optimizations can be made on the user experience. When the matched token has been modified, there is no need to repeat the match in the subsequent search and match process, which can effectively reduce the search time and improve the efficiency of the plug-in.

Bug: Enabling sidekick breaks the VIM mode

See video:

Screen.Recording.2022-02-24.at.11.20.19.mov

I turned Sidekick off, and then this behavior stopped. What happens is, when entering insert mode in VIM, at random points it starts interpreting inputs as if outside insert mode even though I never click on escape.
Someone else reported the same problem on Discord.

BUG: dont work!

When I open this plugin,
image
and the plugin don't work
I try to close all my plugin then open sidekick, unfortunately it also dont work

Bug: Parts of hierarchical tags are highlighted

Screen.Recording.2022-02-22.at.12.04.21.mov

In this video, you can see that in the tag #source/paper, the "paper" part is highlighted, because I use the tag "#paper" somewhere in my vault. However, this shouldn't be a valid recommendation, as #source/paper is already a tag, just a different one. Apparently, the tokenizer considers the /paper as a separate thing, and not as part of the hierarchical tag #source/paper.

Setting for notes to ignore

Hello!

This plugin is awesome! One thing that could be really useful would be the ability to exclude certain notes or folders from suggestions via settings. For example, I have a note for myself in my CRM that has an alias for Me and Myself (which is kinda silly, just did it for tinkering), but now any word that contains me has that part highlighted ๐Ÿ˜† For now I'll just remove that alias, but depending on the subject matter (like chemistry) you might end up with every letter in the alphabet lit up ๐Ÿ˜†

Plugin highlights everything

I have a note called [[Joseph]]. Now the plugin highlights every word containing jo (also in the middle of the word). So I think that the plugin should only highlight entire words when they are contained in the titles of other notes.

Obsidian_OfpdqYrzZh

Curious why lokijs and what it is doing? Thanks!

I am just curious why you chose to use lokiJS database instead of just using a global JS variable arrays/objects? Given that lokiJS doesn't persist to disk and the index is re-built each time on Obsidian load, is it doing any "magic sauce" that a native JS array/object couldn't do? Or is it just something you are familiar with using so you like to use it?

I just am kind of OCD about having plugins add packages/libraries and love to understand why (also to learn).

Thanks! The plugin is coming along nicely!

FR: Let users choose between multiple options

With aliases, it is possible to have multiple rewrites for the same hit. For example:
image

image

It would be very useful if the popup would be a list of such corrections, instead of suggesting only a single one

Bug: Fails to index current vault on Force Reload

I keep having to reenable this plugin whenever I force reload, otherwise it never shows any suggestions. I think the indexing process is happening to early, and should be moved to onLayoutReady

Sidekick links not working

Hi,
I installed Sidekick to use the links suggestions, but for me they are not clickable.
image

If I move the cursor from the popup the links will disappear. You can see also how it's interacting with the text below (highlighting it) and not the popup. So my link suggestions are not clickable, like yours seem to be in the demo.

Do you know why that is? Would this be a Sidekick or a system issue? I tried searching for people with similar problems but find none. Thanks for making Sidekick, by the way.

Bug: Highlights move when typing before it

When adding text before some highlighted text through Sidekick, the highlight moves (ie their position is not properly adjusted). I suppose this is a live preview updating mistake.

Screen.Recording.2022-02-22.at.12.04.21.mov

As an extra less-important bug report, hierarchical tags should probably not be highlighted (ie if I have a #paper tag, #source/paper should probably not be highlighted like this.

Can't enable plugin on ipad

I don't have much info here, but this is all I see in the developer console when trying to enable the plugin on ipad:
IMG_0082

Let me know if there is any more info I can help with!

Latent links directly float the content of the link

image

As shown in the figure, the suspension display of obsidian can be directly invoked on the potential link instead of linking

In this case, I can directly see the content of the potential link without having to link

Is this going to be in the community plugin store?

Hi. Curious if you still plan to develop / finish this wonderful plugin? And if you plan to officially release it to obsidian community repo?

Are there things you need help finishing before submitting it to community repo? I could maybe try to help.

Errors when using plugin

Hi, loving the idea of this plugin! I don't see anywhere in my vault where it is working yet though. It is giving me several TypeErrors too:

image

Appear as Alias

For example, while typing "keyword" which will highlight as a match on sidekick, it shows up a link [[this is a link to the keyword match]]. I'd like it to change to [[this is a link to the keyword match|keyword]] instead of [[this is a link to the keyword match]]

FR: Add links to unresolved files to the index

There might be links to files that do not yet exists. Such links do show up in the Quick Switcher and link suggestor. I have a lot of links I just leave hanging and create later, it would be very useful to have those replacements also show up.

I may pick this up myself at some point. Who knows.

FR: Blacklist common short words / minimum suggestion length

I'm usually creating a lot of daily notes with short, descriptive titles that often contain very common wording ("the", "meeting", "test", ...).
This causes Sidekick to underline every common word as a suggested link - which is complete overkill and probably slows down the process. I'm guessing I can't be alone with this?

I would suggest a "minimum match length" configuration parameter and/or an option to blacklist certain very common words from being linked.

Bug: Stemming (?) mishits

It is reporting many instances of search mishits, where hits could not be found in the index. They probably come from some stemming issue, although I wouldn't know what word it would be based on because I'm fairly sure I have no single-word titles/aliases like 'achieve', 'approximate', 'allow'... etc.

image

In general, it might be a good idea to make the stemming optional, I'm getting a lot of hits now.

Allow partial matches instead of exact filename matches

Hi, just wondering if there will be plans for 'partial matches' as opposed to direct filename matches because it would be far more useful. For example, a similar obsidian plugin https://github.com/tadashi-aikawa/obsidian-various-complements-plugin does partial matches and shows a pulldown menu with several suggestions which 'partially' match instead of having the exact name. It would be nice if there could be an option to enable this! Thank you

Bug: The popup menu acts very flaky

This is so close to perfect! I'm loving it ^^
In the last update with the aliases, I think you changed the popup. However, it's now very hard to use:

Screen.Recording.2022-02-19.at.14.54.34.mov

Clicking or hovering doesn't seem to reliably let me choose the option

ignore yaml & codeblocks

the plugin should not highlight things in yaml and code blocks, since text there has a different meaning and since markdown syntax is invalid there anyway.

Screenshot 2022-02-13 11 39 04

Highlighting multiple words

Love the idea of this plugin. I'm only getting highlight results for single words, is this expected or should also multiple worlds (e.g. "Test Note") be highlighted and suggested?

Bug: False positives with partial matches

I'm seeing some false positives in my vault. In this case, 'on' is highlighted with following replacements:
image

Here, 'matter' is highlighted
image

Same with 'zero'
image

I think this started happening on 1.4.1, and it wasn't like this in 1.4.0 .

(btw... apologies for all the issues I'm making in this repo. I think it will be super useful to me and this plugin will be of huge help to many in the community!)

Suggest link based on note content (not just note title)

I don't know if it's in the scope of the plugin, but suggesting links based on words that are found in headings and/or paragraphs would be awesome :

  1. suggest links based on heading and convert them to [[link#heading]]
  2. suggest links based on paragraphs and convert them to [[link#^paragraph]]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.