Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Endle/fireSeqSearch

When using search engine, it would also search local logseq notebook
https://github.com/Endle/fireSeqSearch

Last synced: 5 days ago
JSON representation

When using search engine, it would also search local logseq notebook

Awesome Lists containing this project

README

        

fireSeqSearch: Append Logseq/Obsidian notes while Googling

Introduction
--------
[fireSeqSearch](https://github.com/Endle/fireSeqSearch) is inspired by [Evernote](https://evernote.com)'s browser extension - if we search a term, for example, `softmax` in Google, [fireSeqSearch](https://github.com/Endle/fireSeqSearch) will also search in our personal notebook, and append the hits into Google results.

More examples at

How to use it
------------------
You need to install **BOTH** the server-side app and the browser extension. The server reads your logseq notebooks in read-only mode, and hosts endpoints at 127.0.0.1:3030.

### Install Browser Extension
1. Install latest web extension
2. If you're using other browser, you can install userscirpts instead. [Tampermonkey](https://www.tampermonkey.net/) => [monkeyscript.user.js](https://github.com/Endle/fireSeqSearch/raw/master/fireSeqSearch_addon/monkeyscript.user.js). [Violentmonkey](https://violentmonkey.github.io/) => [violentmonkeyscript.user.js](https://github.com/Endle/fireSeqSearch/blob/master/fireSeqSearch_addon/violentmonkeyscript.user.js)

### Install Local Server

**Obsidian MD** users: Run `fire_seq_search_server --notebook_path --obsidian-md`. [Example obsidian.sh](https://github.com/Endle/fireSeqSearch/blob/master/fire_seq_search_server/obsidian.sh)

#### Windows
Steps:
1. Download the latest release at
2. If you're using PowerShell, run `.\fire_seq_search_server.exe --notebook_path C:\Users\li\logseq_notebook`
3. If you're using Msys2, run `./fire_seq_search_server --notebook_path /c/Users/li/logseq_notebook`
4. Please remember to change the path to your notebook

#### Linux and macOS
1. Install rust. See
2. `git clone https://github.com/Endle/fireSeqSearch`
3. `cd fire_seq_search_server && cargo build`
4. `target/debug/fire_seq_search_server --notebook_path /home/li/my_notebook`
5. Min rust version: See https://github.com/Endle/fireSeqSearch/blob/master/.github/workflows/rust.yml#L21

License
----------------
This project (both server and addon) is using MIT license. Some third party library may have other licenses (see source code)

Ui icons created by manshagraphics - Flaticon

LOGO link:

LOGO license: Flaticon license

How it works
---------
This is what [fireSeqSearch](https://github.com/Endle/fireSeqSearch) does on my logseq notebook. I had to split it into two parts because Firefox extensions are not allowed to access local files.

fireSeqSearch has two parts:

### 1. search server
It read all local loseq notebooks, and hosts logseq pages on http://127.0.0.1:3030

It provides the API `http://127.0.0.1:3030/query/`

### 2. Browser extension
Every time we use search engine, it will fetch `http://127.0.0.1:3030/query/keywords`and append all hits to the web page.

Similar Projects
--------------
* [karlicoss/promnesia](https://github.com/karlicoss/promnesia) - [Promnesia](https://github.com/karlicoss/promnesia) is a mature and interesting project, aming a more ambitious goal. [fireSeqSearch](https://github.com/Endle/fireSeqSearch) only does one thing - append logseq hits to search engine results.
* Logseq Copilot - https://chrome.google.com/webstore/detail/logseq-copilot/hihgfcgbmnbomabfdbajlbpnacndeihl

Star History
--------

[![Star History Chart](https://api.star-history.com/svg?repos=Endle/fireSeqSearch&type=Date)](https://star-history.com/#Endle/fireSeqSearch&Date)

Provided by