https://github.com/go-shiori/shiori-web-ext

Web extension for using Shiori in Firefox and Chrome
https://github.com/go-shiori/shiori-web-ext

bookmarks hacktoberfest shiori webextension

Last synced: 10 days ago
JSON representation

Web extension for using Shiori in Firefox and Chrome

• Host: GitHub
• URL: https://github.com/go-shiori/shiori-web-ext
• Owner: go-shiori
• License: mit
• Created: 2019-04-21T05:30:30.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-18T06:16:38.000Z (6 months ago)
• Last Synced: 2024-08-01T16:45:23.241Z (3 months ago)
• Topics: bookmarks, hacktoberfest, shiori, webextension
• Language: JavaScript
• Homepage:
• Size: 1.29 MB
• Stars: 435
• Watchers: 11
• Forks: 60
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - go-shiori/shiori-web-ext - Web extension for using Shiori in Firefox and Chrome (hacktoberfest)

README

        
# Shiori Web Extension

[![Donate](https://img.shields.io/badge/donate-PayPal-green.svg)](https://www.paypal.me/RadhiFadlillah)

[![Donate](https://img.shields.io/badge/donate-Ko--fi-brightgreen)](https://ko-fi.com/radhifadlillah)

Shiori Web Extension is a simple extension for managing bookmarks using Shiori. This extension is intended to integrate Shiori with your favorite web browser. This way, you can save and remove bookmarks in Shiori without switching from your current page.

![Screenshot](https://raw.githubusercontent.com/go-shiori/shiori-web-ext/master/docs/screenshot.png)

## Versioning

This project now follows the same versioning system that Shiori uses, that means that starting on `v1.6.0` the extension will match the supported version of the server. This is to avoid confusion and to make it easier to know which version of the extension is compatible with your server.

Different releases for the same server version will be appended as the extension version, for example, `v1.6.0.1` is the first release of the extension for Shiori `v1.6.0`.

## Development Status

This extension is still in beta, however it's already usable at this point. Unfortunately, I've only tested it in Firefox 59+ so there is no guarantee that it will work in another browser.

## Installation

Download the extension from release page then install it in your favorite browser.

## Initial Setup

Before using the web extension, we need to specify the server, username and password to access our Shiori instance. To do so, you can specify it in extension options page.

In Firefox, open add-ons page (`about:addons`) then choose Shiori Web Extension :

![Options page](https://raw.githubusercontent.com/go-shiori/shiori-web-ext/master/docs/options-1.png)

Next click `Preferences` tab then specify server, username and password :

![Options page, preferences tab](https://raw.githubusercontent.com/go-shiori/shiori-web-ext/master/docs/options-2.png)

Once finished, click login button. If all goes well, it will show the currently active session and the extension is ready to use.

## License

Shiori Web Extension is distributed using [MIT license](https://choosealicense.com/licenses/mit/), which means you can use and modify it however you want. However, if you make an enhancement for it, if possible, please send a pull request. If you like this project, please consider donating to me either via [PayPal](https://www.paypal.me/RadhiFadlillah) or [Ko-Fi](https://ko-fi.com/radhifadlillah).