aviral-batra / obsidian-power-search

GNU General Public License v3.0
22 stars 2 forks source link

Obsidian Power Search

Obsidian search is a plugin that allows you to search your notes while you are typing in obsidian (you can currently search your obsidian notes and your anki notes). This has a few benefits:

General setup

  1. Install the plugin from community plugins
  2. Select your debounce refresh timeouts and activate the indexes you want to search by enabling their toggles
  3. Search happens automatically!

Setup for built in indexes

Obsidian

Automatic - just activate in settings!

Anki

  1. Install ankiconnect in anki if you haven't already
  2. Go to Tools -> Addons -> AnkiConnect -> Config and add the line app://obsidian.md to webCorsOriginList, so it is something like this, if you haven't touched the config before
{
    "apiKey": null,
    "apiLogPath": null,
    "webBindAddress": "127.0.0.1",
    "webBindPort": 8765,
    "webCorsOrigin": "http://localhost",
    "webCorsOriginList": [
        "http://localhost",
        "app://obsidian.md"
    ]
}
  1. Restart Anki to apply the changes
  2. Run the plugin with anki running in the background
  3. Activate the anki index in settings

Activating indexes

You can toggle the setting for the index within the "Power Search" Settings tab in obsidian. Toggle the index switch to add a certain type of note to the content to be searched (and rendered in the pane).

Setup for external indexes

TODO

Use

Obsidian power search is an automatic plugin - you don't have to activate the search in any way, just configure and go! While you are typing, it will search your anki notes (more searchable content types added to the index in the future, including custom types) for the line or block of text you are writing (surrounded by whitespace) and provide the best results. There is an obsidian command to reopen the search result pane if it is ever closed.

Config

TODO

Integration with other plugins

TODO

API

TODO

TODO

Now

Future