.circleci | ||
server | ||
src | ||
utils | ||
.babelrc | ||
.eslintrc.js | ||
.flowconfig | ||
.gitignore | ||
LICENSE.md | ||
package.json | ||
publish | ||
README.md | ||
TODO.org | ||
webpack.config.js |
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.
Requirements
No third party dependencies! Just python 3.6
.
Running
-
Install server counterpart as systemd service (to autostart it):
server/setup --path /path/to/your/capture.org [--port <custom port>] [--template <custom org-capture template>]
.Or alternatively, just run it directly if you don't want to autostart it:
server/grasp_server.py --path /path/to/your/capture.org [--port <custom_port>] [--template <custom org-capture template>]
. -
Install chrome extension and configure hotkeys
That's it! If you're using custom port make sure it's same as in the extension settings.
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
-
storage
for settings -
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
- Icon made by Freepik from www.flaticon.com, licensed by CC 3.0 BY
- Original Org Capture extension
- Boilerplate for Webpack Chrome extension)