@kswedberg/new-tab-bookmarks
v1.4.1
Published
New Tab Bookmarks, a browser extension
Downloads
2
Readme
New Tab Bookmarks, a browser extension
This is a work in progress, mostly for personal use, but feel free to use it if you think it might be helpful to you. It uses your browser's bookmarks / favorites as the default page that appears when you open a new tab (hence the catchy name "New Tab Bookmarks"). If you have a lot of bookmarks, you can choose a specific folder whose bookmarks will appear instead of showing all of them.
Other features:
- Filter/search bookmarks, either all of them or just the ones in your selected folder
- Save a new bookmark with an enhanced popup
- Make rudimentary changes to bookmarks (move, rename, reorder, etc.)
- Find duplicate bookmarks and list them, allowing you to delete any one you wish
Some day I might decide to upload it to the Chrome web store or to the Firefox Add-ons site, but for now you'll need to install it as a "development version."
Supported browsers
- Chrome
- Edge
- Opera
- Firefox
Prerequisite
Make sure you have node.js >=8 installed
node --version
If not, either download it from nodejs.org or use a Node.js version manager such as Volta or nvm.
Setup:
git clone https://github.com/kswedberg/new-tab-bookmarks.git
cd new-tab-bookmarks
npm install
(oryarn install
)
Build the extension
To build the extension so that it can be installed in a browser, run one of the following
npm run build-chrome
oryarn build-chrome
: Works for Edge, too.npm run build-opera
oryarn build-opera
npm run build-firefox
oryarn build-firefox
Install it in a browser
Each browser has its own set of instructions/requirements for adding development versions of extensions.
In Chrome or Edge (or, presumably, another Chromium-based browser such as Brave):
- Open the Manage Extensions page (chrome://extensions)
- Check the checkbox for "Developer Mode"
- Press the "Load unpacked extension…" button
- Navigate to this repo's
dist/chrome
directory and select it
In Firefox, the process can be a bit more complicated, depending on which approach you take.
Option A: Follow the instructions for temporary add-on installation.
Option B: If you're using Firefox Developer Edition, Nightly, or ESR, you can install unsigned add-ons by changing xpinstall.signatures.required
to false
in about:config
. Then follow these steps:
- Open the Add-ons Manager (about:addons)
- Click the Gear icon and choose "Install Add-on From File…"
- Navigate to this repo's
dist/firefox
directory and select thefirefox.xpi
file
Option C: Create a signed version of the add-on and install that. This is the most complicated approach. Getting an extension signed is beyond the scope of this document, but here are few resources to get you going in the right direction:
- Read the Extension Workshop's overview, Signing and distributing your add-on page.
- You can either upload the .xpi file (created by running
yarn build-firefox
) to the Developer Hub or use the API. - If you want to use the API:
- Copy
.env.example
to.env
and provide values for the 3 environment variables. You'll need to generate the API Credentials first, obviously. But that just requires clicking a button. - Run
yarn sign-firefox
ornpm run sign-firefox
- Wait for an email telling you the extension has been approved. Then follow the link to download it and follow the 3 steps from Option B.
- Copy
Resources
- https://github.com/abhijithvijayan/web-extension-starter
- https://github.com/mozilla/webextension-polyfill
- https://github.com/Kocal/vue-web-extension