https://github.com/qownnotes/web-companion
Browser extension to browse bookmarks and create notes in QOwnNotes
https://github.com/qownnotes/web-companion
bookmarks browser-extension chrome chrome-extension firefox firefox-extension note-taking qownnotes screenshot vuejs
Last synced: 14 days ago
JSON representation
Browser extension to browse bookmarks and create notes in QOwnNotes
- Host: GitHub
- URL: https://github.com/qownnotes/web-companion
- Owner: qownnotes
- License: gpl-3.0
- Created: 2018-12-27T08:50:31.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T18:56:39.000Z (16 days ago)
- Last Synced: 2025-04-09T19:45:27.003Z (16 days ago)
- Topics: bookmarks, browser-extension, chrome, chrome-extension, firefox, firefox-extension, note-taking, qownnotes, screenshot, vuejs
- Language: Vue
- Homepage: https://www.qownnotes.org/
- Size: 6 MB
- Stars: 82
- Watchers: 2
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [QOwnNotes](https://www.qownnotes.org "QOwnNotes Official Site") Web Companion browser extension
[GitHub](https://github.com/qownnotes/web-companion) |
[Changelog](https://github.com/qownnotes/web-companion/blob/main/CHANGELOG.md) |
[Releases](https://github.com/qownnotes/web-companion/releases) |
[Chrome Web Store](https://chrome.google.com/webstore/detail/qownnotes-web-companion/pkgkfnampapjbopomdpnkckbjdnpkbkp) |
[Firefox Add-ons page](https://addons.mozilla.org/firefox/addon/qownnotes-web-companion) |
[QOwnNotes web page](https://www.qownnotes.org)
[](https://github.com/qownnotes/web-companion/actions/workflows/build-test.yml)
Chrome / Firefox browser extension to interact with the note-taking desktop application [QOwnNotes](https://www.qownnotes.org) for managing bookmarks and act as a web-clipper.
[QOwnNotes](https://www.qownnotes.org) is the **open source** (GPL) plain-text file **Markdown note-taking**
application for GNU/Linux, macOS and Windows, that (optionally) works together with the notes application of
[**ownCloud**](https://github.com/owncloud/notes) or [**Nextcloud**](https://github.com/Nextcloud/notes).
The extension is currently tested for Google Chrome and Mozilla Firefox.
## Features
- **managing bookmarks** with QOwnNotes notes
- you can browse your QOwnNotes bookmarks
- you can search for bookmarks and filter them by tag
- you can add new bookmarks from the current tab or all tabs
- you can add open all bookmarks in tabs
- you can import your browser bookmarks to QOwnNotes
- for more information about the **bookmarks feature** please visit
[QOwnNotes Web Companion browser extension](https://docs.qownnotes.org/en/latest/getting-started/browser-extension/)
- creating a new note (only text) from the **current selection** by right-clicking it
- this is scriptable in QOwnNotes
- creating a new note from the content of the **current web page** by right-clicking on the page
- the HTML will be converted to Markdown and images of the page will be downloaded (might take a while)
- this is scriptable in QOwnNotes
- creating a new note with a **screenshot** of the visible part of the current webpage by right-clicking on the page
- you can change the server socket port in the extension _Option page_
## Screenshot
## Installation
Download the latest release from [Releases](https://github.com/qownnotes/web-companion/releases), visit
`chrome://extensions/` (for Chrome) and drop the extension file into your browser.
You can also use the [Chrome Web Store](https://chrome.google.com/webstore/detail/qownnotes-web-companion/pkgkfnampapjbopomdpnkckbjdnpkbkp)
or the [Firefox Add-ons page](https://addons.mozilla.org/firefox/addon/qownnotes-web-companion) to install the extension.
To use this extension [QOwnNotes](https://www.qownnotes.org) needs to be running.
## Shortcuts
### Chrome
- use Ctrl + B to open the bookmarks popup
### Firefox
- use Ctrl + Alt + B to open the bookmarks popup
### Access keys
Access keys in the bookmarks popup:
- access key A to add a new bookmarks
- access key S to search for bookmarks
- access key O to open all visible bookmarks
- access key T to jump to the tag selector
See [Access keys](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/accesskey)
for more information on how to use access keys in your browser.
## Permissions
- the extension uses the `tabs` permission that may be interpreted as permission to `Read your browsing history` to be able to store bookmarks for all open tabs in a window with a single click
## Development
```bash
npm install
npm run dev-chrome
npm run dev-firefox
```
### Icons
[Material Design Icons](https://fonts.google.com/icons) are used for the extension icons.
## Building packages
```bash
./build.sh
```