diff --git a/CHANGELOG.md b/CHANGELOG.md index d1deee7..4654ce6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,243 +1,3 @@ -# Omnisearch Changelog +# Locator Changelog This changelog is not exhaustive. - -## 1.27.x - -- Updated Svelte from v3 to v5 -- Highlighting improvements - -## 1.26.x - -- Allow `# headings` as display titles in search results -- Added an experimental recency boost -- Added lazy loading for the vault modal items - -## 1.25.x - -- Added basic support for embed references in Vault Search results -- Added support for [Iconize](https://github.com/FlorianWoelki/obsidian-iconize) -- Weights are now 1-10 (instead of 1-5) -- Small performance improvements - -## 1.24.x - -- Added support for [AI Image Analyzer](https://github.com/Swaggeroo/obsidian-ai-image-analyzer) - -## 1.23.x - -- Updated Chinese tokenizer -- Added user-defined boosted fields -- No more freezes when loading large caches (hopefully) -- Large refactoring to properly clean up several older warnings - -## 1.22.x - -- Improved highlighting - -## 1.21.x - -- Added support for .docx and .xlsx - -## 1.20.x - -- Refactored indexing tokenization process to correctly take diacritics into account -- Added highlighting in the note's path -- Improved the selection of the chosen excerpt in the results list - -## 1.19.x - -- Various bugfixes and improvements - -## 1.18.x - -- Added a localhost server to use Omnisearch's API from outside Obsidian - -## 1.17.x - -- Added a shortcut to open files without closing Omnisearch -- Prefill the search field with selected text -- Improved highlighting - -## 1.16.x - -- Various indexing/tokenization improvements - -## 1.15.x - -- Added support of webp images -- Configurable fuzziness -- Added support for DataLoom plugin files -- Unsupported files are now indexed by their path -- Unmarked tags are now slightly boosted - -## 1.14.x - -- Added a `path:` option -- Bugfixes - -## 1.13.x - -- CamelCaseWords are now indexed as 3 words -- Reduced search freezes in some cases - -## 1.12.x - -- You can filter files by their extension -- Refreshed UI -- New API functions -- Fixed some tokenization issues - -## 1.10.x - 1.11.x - -- Added support for Text Extractor; Omnisearch no longer extracts text itself -- Added canvas indexing -- Improved tags indexing - -## 1.9.x - -- PDFs are no longer indexed on mobile -- Performance improvements -- Various bugfixes - -## 1.8.x - -- Added OCR for images -- OCR and PDF indexing are now restricted to desktop. They either don't work or consume too much resources during indexing of big vaults. Too many headaches. -- Notes caching is deactivated on iOS because of crashes: memory usage too high during (de)serializing. -- Added an URL scheme for integration with external tools: `obsidian://omnisearch?query=foo bar` - -## 1.7.x - -### New - -- PDF Indexing https://github.com/scambier/obsidian-omnisearch/issues/58 - -### Improved - -- Code refactor to better scale and handle PDFs as smoothly as possible - -### Fixed - -- Search history https://github.com/scambier/obsidian-omnisearch/issues/104 -- Text in search input was not always correctly selected https://github.com/scambier/obsidian-omnisearch/issues/105 -- Padding issue https://github.com/scambier/obsidian-omnisearch/issues/113 - -### Removed - -- Caching data https://github.com/scambier/obsidian-omnisearch/issues/92#issuecomment-1287647725 - - -## 1.6.x - -### New - -- Omnisearch can now index other plaintext files ~~and PDFs~~ https://github.com/scambier/obsidian-omnisearch/issues/58 -- Search history, navigable with alt+up/down https://github.com/scambier/obsidian-omnisearch/issues/90 -- Added a setting to toggle the visibility of the note excerpt in results https://github.com/scambier/obsidian-omnisearch/issues/70 - -### Improved - -- You can now create a new note in a new pane https://github.com/scambier/obsidian-omnisearch/issues/87 -- Added a setting to show a "create note" button https://github.com/scambier/obsidian-omnisearch/issues/96 - -### Fixed - -- Fixed layout issues https://github.com/scambier/obsidian-omnisearch/issues/97 - -## 1.5.x - -### New - -* Added a toggleable sidebar button to open Omnisearch: https://github.com/scambier/obsidian-omnisearch/issues/60 -* Added a cache-clearing mechanism in case of corruption: https://github.com/scambier/obsidian-omnisearch/issues/83 - -### Improved - -* Notes created by Omnisearch now honour the default note location https://github.com/scambier/obsidian-omnisearch/pull/81 -* Ctrl+click now opens the note in a new pane https://github.com/scambier/obsidian-omnisearch/issues/61 -* Improved highlighting https://github.com/scambier/obsidian-omnisearch/issues/85 - -### Fixed - -* Fixed some edge cases when opening an already open/pinned note https://github.com/scambier/obsidian-omnisearch/issues/51 https://github.com/scambier/obsidian-omnisearch/issues/80 -* Fixed nested tags searching https://github.com/scambier/obsidian-omnisearch/issues/79 -* Fixed a silent crash when clicking on In-File search results https://github.com/scambier/obsidian-omnisearch/issues/84 - -## 1.4.x - -### New - -- Opt-in support for Vim navigation keys: https://github.com/scambier/obsidian-omnisearch/issues/26 -- Opt-in display of "short form" links: https://github.com/scambier/obsidian-omnisearch/issues/59 -- Opt-in search index serialization, for faster loading times: https://github.com/scambier/obsidian-omnisearch/pull/64 by @mnaoumov -- Opt-out: diacritics can now be ignored -- Added support for `#tag` searches: https://github.com/scambier/obsidian-omnisearch/issues/48 -- Added a basic public API for integration with other plugins: https://github.com/scambier/obsidian-omnisearch/issues/22 https://github.com/scambier/obsidian-omnisearch/issues/69 -- Use `alt+enter` to inject a link to the currently selected search result item: https://github.com/scambier/obsidian-omnisearch/issues/32 - - -### Improved - -- You can now switch between "Vault" and "In-File" modals with `tab` -- Search index updates are now done only when Omnisearch is invoked: https://github.com/scambier/obsidian-omnisearch/issues/57 -- New files are now created empty: https://github.com/scambier/obsidian-omnisearch/issues/77 - -### Fixed - -- Opening a pinned note would open it a second time: https://github.com/scambier/obsidian-omnisearch/issues/51 -- Fixed an issue that would index "non-existing notes" multiple times: https://github.com/scambier/obsidian-omnisearch/issues/68 -- Fixed a visual bug for Obsidian 0.15.3: https://github.com/scambier/obsidian-omnisearch/issues/76 -- Fixed the diacritics normalization of the note's title: https://github.com/scambier/obsidian-omnisearch/issues/72 - -## 1.3.x - -### New - -* Chinese support by @aidenlx in https://github.com/scambier/obsidian-omnisearch/pull/37 - * You need to install https://github.com/aidenlx/cm-chs-patch to enable this feature -* Settings page https://github.com/scambier/obsidian-omnisearch/issues/41 -* Do not show indexing Notice by default by @chrisgrieser in https://github.com/scambier/obsidian-omnisearch/pull/46 -* Include notes that don't exist https://github.com/scambier/obsidian-omnisearch/issues/14 - -### Improved - -* Better accessibility https://github.com/scambier/obsidian-omnisearch/issues/50 -* Note aliases are now scored as high as the filename in search results https://github.com/scambier/obsidian-omnisearch/issues/34 -* By default, reindexing is now done when the app is out of focus, and not after each save https://github.com/scambier/obsidian-omnisearch/issues/57 - * On mobile, indexing is only done at startup - -### Fixed - -* Showing an error when a note can't be created https://github.com/scambier/obsidian-omnisearch/issues/52 - - -## 1.2.x - -### New -* #42 Files that are present in Obsidian's "Excluded Files" list are downranked by a factor of 3 (_desktop only_) - -## 1.1.1 - -### Fixes -* Fixed a crash when no results were returned - -## 1.1.0 - -### New -* #25 Search filters: expressions in quotes and exclusions -* Added support for beta versions with [BRAT](https://github.com/TfTHacker/obsidian42-brat) - -This works as a "post-search" filter and does not allow for partial words searches (see #35) - -### Fixes -* #39 Fixed key events not correctly prevented in the search input - -**Full Changelog**: https://github.com/scambier/obsidian-omnisearch/compare/1.0.1...1.1.0 - -## 1.0.1 - -## 1.0.0 - -* First non-beta release -* Includes Vault search and In-File search diff --git a/README.md b/README.md index 359d93b..f605af9 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,31 @@ -# Omnisearch for Obsidian +# Locator for Obsidian [![Sponsor me](https://img.shields.io/badge/%E2%9D%A4%20Like%20this%20plugin%3F-Sponsor%20me!-ff69b4)](https://github.com/sponsors/scambier) ![Obsidian plugin](https://img.shields.io/endpoint?url=https%3A%2F%2Fscambier.xyz%2Fobsidian-endpoints%2Fomnisearch.json) -![GitHub release (latest by date and asset)](https://img.shields.io/github/downloads/scambier/obsidian-omnisearch/latest/main.js) -![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/scambier/obsidian-omnisearch) -![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/scambier/obsidian-omnisearch?include_prereleases&label=BRAT%20beta) - -> 🏆 Winner of the _[2023 Gems of the Year](https://obsidian.md/blog/2023-goty-winners/)_ in the "Existing plugin" category 🏆 +![GitHub release (latest by date and asset)](https://img.shields.io/github/downloads/scambier/obsidian-locator/latest/main.js) +![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/scambier/obsidian-locator) +![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/scambier/obsidian-locator?include_prereleases&label=BRAT%20beta) --- -**Omnisearch** is a search engine that "_just works_". +**Locator** is an Obsidian plugin that lets you locate your files in a few keystrokes. It is a lightweight version of Omnisearch. + It always instantly shows you the most relevant results, thanks to its smart weighting algorithm. -Under the hood, it uses the excellent [MiniSearch](https://github.com/lucaong/minisearch) library. This free plugin is totally unrelated to the omnisearch.ai paid product. +Under the hood, it uses the excellent [MiniSearch](https://github.com/lucaong/minisearch) library. ![](https://raw.githubusercontent.com/scambier/obsidian-omnisearch/master/images/omnisearch.gif) -## Documentation - -https://publish.obsidian.md/omnisearch/Index - ## Installation -- Omnisearch is available on [the official Community Plugins repository](https://obsidian.md/plugins?search=Omnisearch). -- Beta releases can be installed through [BRAT](https://github.com/TfTHacker/obsidian42-brat). **Be advised that those - versions can be buggy and break things.** +- Locator can be installed through [BRAT](https://github.com/TfTHacker/obsidian42-brat). You can check the [CHANGELOG](./CHANGELOG.md) for more information on the different versions. ## Features -> Omnisearch's first goal is to _locate_ files instantly. You can see it as a _Quick Switcher_ on steroids. +> Locator's first goal is to _locate_ files instantly. You can see it as a _Quick Switcher_ on steroids. - Find your **📝notes, 📄Office documents, 📄PDFs, and 🖼images** faster than ever - Images, documents, and PDF indexing is available @@ -45,7 +38,6 @@ You can check the [CHANGELOG](./CHANGELOG.md) for more information on the differ - Workflow similar to the "Quick Switcher" core plugin - Opt-in local HTTP server to query Omnisearch from outside of Obsidian - Resistance to typos -- Switch between Vault and In-file search to quickly skim multiple results in a single note - Supports `"expressions in quotes"` and `-exclusions` - Filters file types with `.jpg` or `.md` - Directly Insert a `[[link]]` from the search results @@ -55,21 +47,18 @@ You can check the [CHANGELOG](./CHANGELOG.md) for more information on the differ on [this additional plugin](https://github.com/aidenlx/cm-chs-patch) (also you may need to clear search cache data to apply new Chinese index). Please read its documentation for more information. -## Projects that use Omnisearch +## Issues & Feature Requests -_Submit a PR to add your own project!_ +If you're reading this README from the [repository's page](https://git.scambier.xyz/scambier/obsidian-locator), you'll notice it is hosted on a private forge without account registration. +Locator is a personal hobby project, tailored for my own needs. It is publicly available because you may find it useful too, but I'm not interested in your issues or pull requests. -- [Omnisearch Companion](https://github.com/ALegendsTale/omnisearch-companion), an extension for your browser ([Firefox](https://addons.mozilla.org/en-US/firefox/addon/omnisearch-companion/), [Chrome](https://chromewebstore.google.com/detail/omnisearch-companion/kcjcnnlpfbilodfnnkpioijobpjhokkd)) -- [Actions for Obsidian](https://actions.work/actions-for-obsidian) -- [Userscripts](https://publish.obsidian.md/omnisearch/Inject+Omnisearch+results+into+your+search+engine) to inject Omnisearch into your favorite web search engine +Thank you for your understanding. ## LICENSE -Omnisearch is licensed under [GPL-3](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)). +Locator is licensed under [GPL-3](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)). ## Thanks To all people who donate through [Ko-Fi](https://ko-fi.com/scambier) or [Github Sponsors](https://github.com/sponsors/scambier) ❤ - -![JetBrains logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg) diff --git a/src/components/ModalVault.svelte b/src/components/ModalVault.svelte index b20c280..8d09593 100644 --- a/src/components/ModalVault.svelte +++ b/src/components/ModalVault.svelte @@ -1,7 +1,7 @@