aynish/grasp
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
25 commits 1 branch 0 tags 384 KiB
JavaScript 46.7%
Python 42.8%
Nix 6.3%
HTML 2.5%
Shell 1.7%
Find a file
Dima Gerasimov 7b9abd159c Add link to Chrome store
2019-01-07 00:03:03 +00:00
.circleci fix eslint, add to ci 2019-01-06 21:00:47 +00:00
server get rid of kython for server counterpart 2019-01-06 23:57:15 +00:00
src stricter permissions 2019-01-06 23:27:27 +00:00
utils Collapse boilerplate in a single commit 2019-01-05 10:17:50 +00:00
.babelrc set up webpack etc 2019-01-05 10:18:14 +00:00
.eslintrc.js fix eslint, add to ci 2019-01-06 21:00:47 +00:00
.flowconfig notification, proper message routing, etc 2019-01-05 10:18:14 +00:00
.gitignore Collapse boilerplate in a single commit 2019-01-05 10:17:50 +00:00
LICENSE.md update webpack and version 2019-01-05 13:55:22 +00:00
package.json stricter permissions 2019-01-06 23:27:27 +00:00
publish get rid of kython for server counterpart 2019-01-06 23:57:15 +00:00
README.md Add link to Chrome store 2019-01-07 00:03:03 +00:00
TODO.org Add link to Chrome store 2019-01-07 00:03:03 +00:00
webpack.config.js Update readme, set up icon 2019-01-06 22:16:36 +00:00

README.md

Build status: CircleCI

Grasp is an extension for Chrome (Firefox support is in progress), which adds a button/keybinding to capture current page title and url, possibly selected text, additional comments or tags and send it into your Org Mode file.

See a short demo.

Requirements

  • pip3 install --user hug for Hug HTTP server.

Running

  1. Install server counterpart as systemd service: server/setup.
  2. Install chrome extension and configure hotkeys

That's it! Currently port 12212 is hardcoded, but it will be configurable.

Motivation

Why use org-capture? Well, it's hard to explain, maybe some other time... However if you do know you want to use it instead/alongside your browser bookmarks, by default you don't have much choice and have to copy everything manually. For an average Org Mode user it's a torture.

For a while, I used the only Chrome extension for that (as for January 2019). However, it relies on setting up MIME handler which is quite flaky for many people. What is more, capturing via org template requires always running emacs daemon, which might be too much for some people. But the worst thing is if capturing fails, you have to way of knowing about it. After losing few days of captured stuff due to MIME handler mysteriously not working, I got fed up and figured it's time to implement something more reliable.

My approach still requires a running server, but it's a simple python script which simply appends a text entry to a text file. The backend always responds back and in case anything fails, you get a notification.

Extra collateral benefit is that you can potentially add anything as a backend, e.g. you might be more of a Markdown or Todo.txt fan (let me know if you are interested in that!).

Potentional improvements

  • due to server counterpart, one could even run it elsewhere, not necessarily on localhost
  • also see todos

Building extension

The most up-to-date instructions should be in CI config.

You're gonna need npm for building extension.

npm install
npm run build

After that you can find the extension in build directory and 'Load unpacked' if necessary. There is also Flow and Eslint set up.

Permissions used

  • notifications for showing error notification

  • activeTab for requesting url, title and selected text

  • http://localhost/capture for talking with backend

  • content_security_policy needed for webpack.

Credits