Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jk-oster/obsidian-search-for-web
A browser extension to search your obsidian vault from the browser
https://github.com/jk-oster/obsidian-search-for-web
chrome-extension obsidian-md vue
Last synced: about 2 months ago
JSON representation
A browser extension to search your obsidian vault from the browser
- Host: GitHub
- URL: https://github.com/jk-oster/obsidian-search-for-web
- Owner: jk-oster
- Created: 2022-10-26T16:09:21.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T20:11:58.000Z (2 months ago)
- Last Synced: 2024-10-17T06:28:19.704Z (2 months ago)
- Topics: chrome-extension, obsidian-md, vue
- Language: Vue
- Homepage:
- Size: 454 KB
- Stars: 20
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Obsidian Web Search
>❗note that this extension is still experimental - furthermore this extension requires the Obsidian REST API Plugin!
## 🔍 Have a Evernote like search experience
For all of you who are missing the Evernote browser search extension in Obsidian - here is your solution.
This extension lets you search your Obsidian Vault simultaneously as you type your search in your favourite search engine.
## 🚀 Features
- ✅ LIVE SEARCH: Search your vault for notes matching your current search in e.q. the google search bar
- ✅ URL MATCHING: Search your vault for matches of your current url while browsing
- ✅ Choose your favourite search provider Local REST API or OmniSearch Plugin
- ✅ Scroll and open your matched Obsidian notes in the sidebar
- ✅ Exclude files and folders you don't want to show up in the sidebar search
### 🛡️ Privacy
This extension just communicates between your local Obsidian REST Api and the browser.
The only data that is stored permanently in the browser are the settings including the Obsidian REST API-Key.
### 🌐 Browser compatibility
This extension has been tested with Chrome on Windows to be working.
By using the webextension-polyfill library of mozilla.org it should also be compatible with Firefox though.
## 🚧 Test the extension
>❗note that this extension is still experimental - furthermore this extension requires the Obsidian REST API Plugin!
1. test it by downloading the released zip file
2. extracting the files
3. [installing the folder from the chrome extension tab](https://bashvlas.com/blog/install-chrome-extension-in-developer-mode/)
4. open the settings tab of the extension
5. insert the obsidian REST API key and input vault name
6. go to any webpage and see the number of matching notes in the extension icon
## 🏗️ Build it yourself
Clone the repository, install dependencies `npm install` (or better use `pnpm install`) and run `npm dev` / `pnpm dev`.
THis should automatically start chrome with the extension installed.
## Contact & contribution
If you need any support feel free to comment in de discussions or open up an issue.
You can also contact me though my [website](https://jakobosterberger.com/contact).
Contribution, pull requests and suggestions for improvements are very welcome.
## Credits
Thank's to the creator of the Obsidian Local REST Api Plugin @Adam Coddington for his awesome work as well as to @scambier for the obsidian-omnisearch plugin.
Furthermore, kodos to the creator of the Vite Chrome Extension Plugin for enabling fast and easy development with Vue!
Big thanks to the team of Flowbite™ for providing such awesome free Tailwind components!