Trilium Web Clipper is a web browser extension which allows user to clip text, screenshots, whole pages and short notes and save them directly to Trilium Notes.
-Project is hosted here.
-Firefox and Chrome are supported browsers, but the chrome build should - work on other chromium based browsers as well.
+Trilium Web Clipper officially supports the following web browsers:
+Mozilla Firefox, using Manifest v2.
+Google Chrome, using Manifest v3. Theoretically the extension should work + on other Chromium-based browsers as well, but they are not officially supported.
+Trilium will save these clippings as a new child note under a "clipper inbox" note.
By default, that's the day note but you @@ -23,21 +40,33 @@ spellcheck="false">clipperInbox, on any other note.
If there's multiple clippings from the same page (and on the same day), then they will be added to the same note.
-Extension is available from: -
+Keyboard shortcuts are available for most functions:
To set custom shortcuts, follow the directions for your browser.
+about:addons →
+ Gear icon ⚙️ → Manage extension shortcutschrome://extensions/shortcuts
The extension needs to connect to a running Trilium instance. By default, it scans a port range on the local computer to find a desktop Trilium instance.
It's also possible to configure the server address if you don't run the desktop application, or want it to work without the desktop application running.
-Older versions of Trilium (before 0.50) required username & password - to authenticate, but this is no longer the case. You may enter anything - in that field, it will not have any effect.
\ No newline at end of file +Some parts of the code are based on the Joplin Notes browser extension.
\ No newline at end of file diff --git a/apps/web-clipper/README.md b/apps/web-clipper/README.md deleted file mode 100644 index a37d0e181..000000000 --- a/apps/web-clipper/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Trilium Web Clipper - -## This repo is dead - -**Trilium is in maintenance mode and Web Clipper is not likely to get new releases.** - -Trilium Web Clipper is a web browser extension which allows user to clip text, screenshots, whole pages and short notes and save them directly to [Trilium Notes](https://github.com/zadam/trilium). - -For more details, see the [wiki page](https://github.com/zadam/trilium/wiki/Web-clipper). - -## Keyboard shortcuts -Keyboard shortcuts are available for most functions: -* Save selected text: `Ctrl+Shift+S` (Mac: `Cmd+Shift+S`) -* Save whole page: `Alt+Shift+S` (Mac: `Opt+Shift+S`) -* Save screenshot: `Ctrl+Shift+E` (Mac: `Cmd+Shift+E`) - -To set custom shortcuts, follow the directions for your browser. - -**Firefox**: `about:addons` > Gear icon ⚙️ > Manage extension shortcuts - -**Chrome**: `chrome://extensions/shortcuts` - -## Credits -Some parts of the code are based on the [Joplin Notes browser extension](https://github.com/laurent22/joplin/tree/master/Clipper). diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md index ea5d135a2..d840ffd46 100644 --- a/docs/Developer Guide/Developer Guide/Documentation.md +++ b/docs/Developer Guide/Developer Guide/Documentation.md @@ -1,5 +1,5 @@ # Documentation -There are multiple types of documentation for Trilium:
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/User Guide/User Guide/Installation & Setup/Web Clipper.md b/docs/User Guide/User Guide/Installation & Setup/Web Clipper.md
index bd5731d34..a74fb72d0 100644
--- a/docs/User Guide/User Guide/Installation & Setup/Web Clipper.md
+++ b/docs/User Guide/User Guide/Installation & Setup/Web Clipper.md
@@ -3,9 +3,19 @@
Trilium Web Clipper is a web browser extension which allows user to clip text, screenshots, whole pages and short notes and save them directly to Trilium Notes.
-Project is hosted [here](https://github.com/TriliumNext/web-clipper).
+## Supported browsers
-Firefox and Chrome are supported browsers, but the chrome build should work on other chromium based browsers as well.
+Trilium Web Clipper officially supports the following web browsers:
+
+* Mozilla Firefox, using Manifest v2.
+* Google Chrome, using Manifest v3. Theoretically the extension should work on other Chromium-based browsers as well, but they are not officially supported.
+
+## Obtaining the extension
+
+> [!WARNING]
+> The extension is currently under development. A preview with unsigned extensions is available on [GitHub Actions](https://github.com/TriliumNext/Trilium/actions/runs/21318809414).
+>
+> We have already submitted the extension to both Chrome and Firefox web stores, but they are pending validation.
## Functionality
@@ -15,16 +25,29 @@ Firefox and Chrome are supported browsers, but the chrome build should work on o
* save screenshot (with crop tool) from either popup or context menu
* create short text note from popup
+## Location of clippings
+
Trilium will save these clippings as a new child note under a "clipper inbox" note.
By default, that's the [day note](../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.md) but you can override that by setting the [label](../Advanced%20Usage/Attributes.md) `clipperInbox`, on any other note.
If there's multiple clippings from the same page (and on the same day), then they will be added to the same note.
-**Extension is available from:**
+## Keyboard shortcuts
-* [Project release page](https://github.com/TriliumNext/web-clipper/releases) - .xpi for Firefox and .zip for Chromium based browsers.
-* [Chrome Web Store](https://chromewebstore.google.com/detail/trilium-web-clipper/dfhgmnfclbebfobmblelddiejjcijbjm)
+Keyboard shortcuts are available for most functions:
+
+* Save selected text: Ctrl+Shift+S (Mac: ⌘+⇧+S)
+* Save whole page: Alt+Shift+S (Mac: ⌥+⇧+S)
+* Save screenshot: Ctrl+Shift+E (Mac: ⌘+⇧+E)
+
+To set custom shortcuts, follow the directions for your browser.
+
+* **Firefox**: `about:addons` → Gear icon ⚙️ → Manage extension shortcuts
+* **Chrome**: `chrome://extensions/shortcuts`
+
+> [!NOTE]
+> On Firefox, the default shortcuts interfere with some browser features. As such, the keyboard combinations will not trigger the Web Clipper action. To fix this, simply change the keyboard shortcut to something that works. The defaults will be adjusted in future versions.
## Configuration
@@ -32,6 +55,6 @@ The extension needs to connect to a running Trilium instance. By default, it sca
It's also possible to configure the [server](Server%20Installation.md) address if you don't run the desktop application, or want it to work without the desktop application running.
-## Username
+## Credits
-Older versions of Trilium (before 0.50) required username & password to authenticate, but this is no longer the case. You may enter anything in that field, it will not have any effect.
\ No newline at end of file
+Some parts of the code are based on the [Joplin Notes browser extension](https://github.com/laurent22/joplin/tree/master/Clipper).
\ No newline at end of file