tezlm/shiori-injector
1
0
Fork 0
Code Issues Pull requests Releases Activity
shiori-injector/README.md
tezlm 323779d351
port
2022-12-18 17:51:33 -08:00

2.9 KiB
Raw Permalink Blame History

Shiori injector

This is a fork of linkding-injector to work with shiori.

Original readme below:

Community browser extension for the self-hosted linkding bookmark service.

Features

  • When searching on a search engine the search term is also sent to your linkding instance and results are added in a new box in the sidebar right to the search engine results.
  • Supports google and duckduckgo search engines
  • Automatic light or dark theme detection

Works with: Firefox, Chrome

Usage

After installation the extension needs to be configured and connected to your linkding instance. Either open the extension options in the browser extension manager or follow the link in the new linkding injector box on the search page of google or duckduckgo.

Once the extension is properly configured linkding search results will show in the right sidebar. If there are no search results nothing will appear.

Screenshots

duckduckgo google

Installation

Firefox: Mozilla Addon Store

Chrome: Chrome Web Store

Manual installation

Firefox

Run the build as described below and then follow the instructions here to load it into Firefox.

Chrome

Run the build as described below and then follow the instructions here to load it into Chrome.

Build

Requirements

  • Latest LTS Node version (v14)
  • Latest LTS NPM version (v6)
  • bash (on Linux) or powershell (on Windows)
  • npx (included with npm v5.2+)

Internally, we use web-ext to bundle a distribution package for the extension for Firefox. You do not need to install web-ext. Note that web-ext will generate a zip file which can also be used for the Chrome Web Store.

Then run the following script to generate a build (might need to make the file executable on Linux using chmod +x build.sh):

./build.sh # Linux

./build.ps1 # Windows

The script does:

  • Install all dependencies using NPM
  • Runs rollup to transpile and minify source files, with output written to the build directory
  • Run web-ext to package the extension for uploading to the Mozilla addon store

After the build the root directory contains the complete, unpackaged extension. Use the manifest.json file to load it manually into the browser.

The packaged extension can be found in the web-ext-artifacts folder.

Acknowledgements

This extension reuses and adapts code from the official linkding extension.