Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 2.74 KB

README.sync-conflict-20230221-122229-MV5T25L.md

File metadata and controls

44 lines (35 loc) · 2.74 KB
Raw

Joplin Web Clipper for Safari

This is an Safari App Extension for a Joplin Web Clipper.

Joplin is an open-source note taking and to-do application. It includes browser extensions for Chrome and Firefox that allows you to clip the current page/tab into Joplin. This extension is built with Javascript and React.

However, Safari now requires extensions that are at least partially based on native code (Swift or Objective-C) and must be initally run from a Mac app. This means the Web Clipper included with Joplin will not work. There is currently no Safari App Extension that I am aware of. This is my attempt at making one.

There are now three versions of the extension based on what official release version of Joplin you are using (due to changes to the underlying APIs):

  • Joplin v2.1.5 or higher, use Clipper v0.2.1.
    • This will now require you to grant permission from Joplin app when you try to use the Clipper.
    • Once permission is granted, the Clipper should work normally.
  • Joplin v1.4.12 to v2.1.3, use Clipper v0.2.0.
  • Joplin prior to v1.4.12, you need to use Clipper v0.1.3.

Please note that this is very much ALPHA quality code at this point. The core functionality works for normal day-to-day usage (which I do), but you will find bugs and issues.

Installation

  • Download the executable either from one of the links above or from the Releases page
  • Unzip the file and move the executable to the Applications folder
  • Run the executable once. You’ll be prompted to enable it in Safari Extensions
  • After that, you should see a button with the Joplin logo in the toolbar
  • Click the extension button
  • If you are using Clipper v0.2.1, you will need to do the following:
    • If Joplin is running, you'll be asked to grant permission. Go over to Joplin to do that.
    • If Joplin is not running, you'll see a message that it is unavailable. Start Joplin, then grant permission

Working

  • Clip URL
  • Clip Complete Page (to Markdown)
  • Clip Simplified Page
  • Folder Selector (now remembers last folder used and supports subfolders)
  • Server Status Check
  • Tags
  • Clip Selection
    • If you are using StopTheMadness, you will need to allow "Text selection" for "Clip Selection" to work.

Not Working/Missing

  • Clip Complete Page (to HTML)
  • Clip Image Capture

I'm new at Safari App Extension development, so bear with me as we learn along together!

License

Joplin Web Clipper is available under the MIT license. See the LICENSE.md file for more info.