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: 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
- License: gpl-3.0
- Created: 2022-10-26T16:09:21.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-12T18:57:52.000Z (3 months ago)
- Last Synced: 2025-03-22T16:52:50.666Z (3 months ago)
- Topics: chrome-extension, obsidian-md, vue
- Language: Vue
- Homepage: https://vaultlens.com
- Size: 4.49 MB
- Stars: 39
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
README
# Vault Lens
## (formerly Obsidian Browser Search)
>❗note that this extension requires the [Local REST API](https://github.com/coddingtonbear/obsidian-local-rest-api) or [Omnisearch](https://github.com/scambier/obsidian-omnisearch) Plugin installed!
## Quickstart
- [Install now on Chrome Web Store](https://chromewebstore.google.com/detail/obsidian-browser-search/ikdemlfoilfdmcdiegelchlhfnkpmaee)
- [Install now on Mozilla Add-on Store](https://addons.mozilla.org/de/android/addon/vault-lens/)
- [Install now on Microsoft Edge Add-on Store](https://microsoftedge.microsoft.com/addons/detail/vault-lens/famedkcjbljkkabgpphnioagamckhmcj)
- Follow the [quickstart manual](https://jk-oster.github.io/obsidian-search-for-web/getting-started.html).
## 🔗 Connect your Vault to the Browser
Search your Obsidian vault simultaneously as you type your search in your favorite search engine.
### 🔍 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.
### ✂️ Web Clipper Companion
This extension is a perfect companion for the official [Obsidian Web Clipper Extension](https://obsidian.md/clipper). With the Official Web Clipper you can save content to your Obsidian Vault while browsing, and this extension will allow you to resurface these saved notes as you revisit the page later or type a search for it in your search engine.
## 🚀 Features
Find the full feature list [in the docs](https://jk-oster.github.io/obsidian-search-for-web/feature-guide.html). Also you can find the [roadmap](https://jk-oster.github.io/obsidian-search-for-web/roadmap.html) for future features.
- ✅ LIVE SEARCH: Search your vault for notes matching your current search in e.q. the google search bar
- ✅ NOTE RECALL: Search your vault for matches of your current url while browsing
- ✅ EMBEDDED RESULTS: See your notes embedded in the search engine results
- ✅ NOTE PREVIEW: Peek into the note contents without leaving the browser
- ✅ DARK MODE: Supports dark and light mode
- ✅ PAGE NOTES: Show notifications when browsing pages that have dedicated notes in your vault
- ✅ 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. For details read the [privacy statement](https://jk-oster.github.io/obsidian-search-for-web/privacy.html).
Also find details about the [permission this extension requires](https://jk-oster.github.io/obsidian-search-for-web/privacy.html#extension-permissions) in the docs.
### 🌐 Browser compatibility
Firefox supported since version >=2.5.2 and can be installed through the [add-on store](https://addons.mozilla.org/de/android/addon/vault-lens/). For details read the [FAQ](https://jk-oster.github.io/obsidian-search-for-web/faq.html#is-obsidian-browser-search-also-available-for-firefox).
## 🚧 Test the extension
0. open your obsidian vault in the app and install either the local REST API plugin or the omnisearch plugin
1. test this extension by downloading the latest released zip file
2. extract the files
3. [install 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. configure your search provider and input vault name in the settings
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 run dev` / `pnpm dev`.
This should automatically start chrome with the extension installed.
## Disclaimer
This is an unofficial browser extension for Obsidian. The project is not sponsored, endorsed or affiliated with Dynalist Inc, the makers of [Obsidian.md](https://obsidian.md). The obsidian logo is property of https://obsidian.md.
## Contact & contribution
If you need any support feel free to comment in the discussions or open up an [issue](https://github.com/jk-oster/obsidian-search-for-web/issues).
You can also contact me though my [website](https://jakobosterberger.com/contact).
Contribution, pull requests and suggestions for improvements are very welcome.
## Credits
Thanks 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, kudos 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!