spacemacs/layers/+tools/evernote/README.org

65 lines
2.2 KiB
Org Mode

#+TITLE: Evernote contribution layer for Spacemacs
[[file:img/evernote.png]] with [[file:img/geeknote.png]]
* Table of Contents :TOC@4:
- [[#description][Description]]
- [[#install][Install]]
- [[#layer][Layer]]
- [[#geeknote][geeknote]]
- [[#geeknoteel][geeknote.el]]
- [[#key-bindings][Key Bindings]]
* Description
This layer groups together packages to work with [[https://evernote.com/][Evernote]].
It uses the non official Evernote command line tool [[http://www.geeknote.me][geeknote]] which allows users
to write notes in markdown, and sync them.
[[https://github.com/avendael/emacs-geeknote][geeknote.el]] is a wrapper for some of the most used =geeknote= commands. By
default, =geeknote.el= doesn't have key bindings defined. This contribution
layer provides key bindings for all of geeknote.el's exposed features.
* Install
** Layer
To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(evernote))
#+END_SRC
** geeknote
The command =geeknote= is expected to be present in your =$PATH=. To
obtain this utility, please refer to the official geeknote
[[http://www.geeknote.me/documentation/][documentation]].
** geeknote.el
=geeknote.el= relies on having a correctly setup geeknote editor. To set
this up, run the following command in your terminal after successfully
installing =geeknote=:
#+BEGIN_SRC sh
$ geeknote settings --editor "emacsclient"
#+END_SRC
If you would prefer to customize the geeknote command to be used such as
specifying the path to the geeknote python script, please refer to the
=geeknote.el= [[https://github.com/avendael/emacs-geeknote][documentation]]. For more information about setting up =$PATH=,
checkout corresponding section in FAQ (~SPC f e h $PATH RET~).
* Key Bindings
| Key Binding | Description |
|-------------+-------------------------------------|
| ~SPC a e c~ | create a new note |
| ~SPC a e e~ | edit an existing note |
| ~SPC a e f~ | find a note using a keyword |
| ~SPC a e s~ | show an existing note |
| ~SPC a e r~ | remove an existing note |
| ~SPC a e m~ | move a note to a different notebook |