Recently Written · git

sbm-extension

sbm bookmarks for Firefox and Chrome: fuzzy search, add the page, sync with bm and the sbm app

git clone https://github.com/equwal/sbm-extension

Log | Files | Refs


README.md (4979 bytes)

1 # sbm for Firefox and Chrome
2 
3 Your [sbm](https://github.com/equwal/sbm) bookmarks in the browser.
4 
5 ![bm adds a page in the terminal; the add-on shows it at once and adds another, which bm then shows](https://raw.githubusercontent.com/equwal/sbm-sync/master/demo/sbm-demo.gif)
6 
7 ([MP4](https://github.com/equwal/sbm-sync/raw/master/demo/sbm-demo.mp4), 80 seconds.)
8 
9 - **Search as you type** in the popup (Alt+Shift+M), with the fuzzy match of
10   fzf. Enter opens the first match. Text that is no bookmark opens as an
11   address, or as a web search, as in bm.
12 - **Address bar:** type `bm`, a space, then words.
13 - **Add this page** with a description and tags.
14 - **Sync** with bm on your computers, the
15   [sbm app for Android](https://github.com/equwal/sbm-android) and your other
16   browsers, through an [sbm-sync](https://github.com/equwal/sbm-sync) server.
17 
18 Without an account, the bookmarks stay in the browser. With an account, the
19 add-on syncs when it starts, when you open the popup, after you add a
20 bookmark, and every 30 minutes.
21 
22 The bookmarks are an sbm file: one bookmark per line,
23 `URL<tab>description<tab>tags`.
24 
25 ## Sync
26 
27 The add-on uses https://sbmsync.com unless you give another server in
28 the options. Create an account there. Sync on that server is free. Or
29 [run your own server](https://github.com/equwal/sbm-sync): it is free
30 software.
31 
32 The options page shows the plan of your account and the payments that the
33 server offers. When the server has billing, subscribe there, and use
34 "Manage billing" to change the card or cancel. The page also links to the
35 other payment pages of the server, such as a supporter subscription and the
36 page to cancel it, and to the terms of sale. Stripe takes all payments, on
37 its own pages in a new tab. The add-on never sees your card.
38 
39 ## Permissions
40 
41 - `storage`: keep the bookmarks and the sign-in token.
42 - `activeTab`: read the address and the title of the page when you click
43   "Add this page".
44 - `alarms`: sync every 30 minutes.
45 - Access to sbmsync.com and its old address sbm.subread.space, or to the
46   server that you choose: sync.
47 
48 Firefox also asks you, at sign-in, to let the add-on send your bookmarks,
49 your email address and your password to the server. The
50 [privacy policy](https://sbmsync.com/privacy) tells what the server
51 keeps.
52 
53 ## Develop
54 
55 The add-on needs no build: load this directory as an unpacked extension
56 (Chrome: chrome://extensions, developer mode; Firefox: about:debugging).
57 
58     npm install
59     npm test          # property tests of the file format and the search
60     npm run lint      # the checks of addons.mozilla.org, on the Firefox package
61     npm run build     # the zip for the Chrome Web Store, in web-ext-artifacts/
62     npm run build:firefox  # the zip for addons.mozilla.org
63 
64 The two zips have the same files. Only the manifest.json of the Firefox zip
65 has no `background.service_worker`: Firefox ignores it and warns about it,
66 and Chrome needs it.
67 
68 ## More projects
69 
70 - [SubRead](https://subread.space/): read along with an audiobook, in the browser.
71   Also [for Android](https://github.com/equwal/subread-android/releases/latest),
72   [for YouTube](https://github.com/equwal/subread-extension/releases/latest)
73   and [for KOReader](https://github.com/equwal/subread.koplugin).
74 - [SubRead Overlay](https://github.com/equwal/subread-overlay/releases/latest): subtitle lines over any Android media player.
75 - [SubRead Dictionary](https://github.com/equwal/subread-dictionary/releases/latest): a pop-up dictionary for Android that reads Yomitan dictionaries.
76 - [SubRead Anki](https://github.com/equwal/subread-anki): one tap makes an Anki card from any Android app.
77 - [Subrep](https://github.com/equwal/subrep-android/releases/latest): live captions of the sound of your phone.
78 - [Book Simulator](https://booksimulator.com/): a reading room for Aozora Bunko and Project Gutenberg books.
79 - [honjimaku.com](https://honjimaku.com/): subtitles for Japanese audiobooks.
80 - [sbm Sync](https://sbmsync.com/): your bookmarks, the same on every device,
81   with [sbm](https://github.com/equwal/sbm) for dmenu,
82   [sbm for Android](https://github.com/equwal/sbm-android/releases/latest)
83   and the [sbm add-on](https://github.com/equwal/sbm-extension/releases/latest) for Firefox and Chrome.
84 - [Rebind](https://github.com/equwal/rebind/releases): remap the hardware buttons of e-ink readers and Android,
85   with [Ink Recents](https://github.com/equwal/ink-recents/releases/latest),
86   [Ink Dim](https://github.com/equwal/ink-dim/releases/latest)
87   and [Ink Update](https://github.com/equwal/ink-update/releases/latest).
88 - [dickt.store](https://dickt.store/): language-learning tools, flashcards and web toys.
89 - [hentaibun.online](https://hentaibun.online/): learn kanbun and kobun.
90 - [Recently Written](https://recentlywritten.com/): the blog, and a list of [all projects](https://recentlywritten.com/projects.html).
91 
92 ## License
93 
94 AGPL-3.0. If sbm is useful to you, you can support it on
95 [Ko-fi](https://ko-fi.com/truex).