summaryrefslogtreecommitdiff
path: root/README.org
blob: 2895d400e2a6d833e873d92dcf72cdaa71f9f494 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#+TITLE: evil-org-mode

Supplemental evil-mode key-bindings to Emacs org-mode.
This is an extended and actively maintained version of https://github.com/edwtjo/evil-org-mode/blob/master/evil-org.el that was originally created by Edward Tjörnhammar.

** New features since evil-org-mode

 - [X] less controversial default keybindings (see issue [[https://github.com/edwtjo/evil-org-mode/issues/13][#13]])
 - [X] key themes
 - [X] customizable movement keys
 - [X] operators
 - [X] text objects
 - [X] insert mode bindings
 - [X] table support

** Requirements

 - org-mode, git://orgmode.org/org-mode.git
 - evil-mode, https://bitbucket.org/lyro/evil
 - evil-leader, https://github.com/cofi/evil-leader.git

** Installation

 #+BEGIN_SRC sh
   mkdir -p ~/.emacs.d/plugins; git clone git://github.com/somelauw/evil-org-improved.git ~/.emacs.d/plugins/evil-org-mode
 #+END_SRC

*** emacs.el

 #+begin_src emacs-lisp
     (add-to-list 'load-path "~/.emacs.d/plugins/evil-org-mode")
     (require 'evil-org)
     (evil-org-set-key-theme '(textobjects insert additional))
 #+end_src

** Keybindings
  
   |----------------+---------------------------|
   | key            | explanation               |
   |----------------+---------------------------|
   | M-ret          | insert heading            |
   | TAB            | fold / unfold headings    |
   | gh, gj, gk, gl | navigate between elements |
   | vae            | select an element         |
   | var            | select a subtree          |
   | M-h or <<      | promote a heading         |
   | M-l or >>      | demote a heading          |
   | M-k            | move subtree up           |
   | M-j            | move subtree down         |
   | M-S-h or <ar   | promote a subtree         |
   | M-S-l or >ar   | demote a subtree          |
   |----------------+---------------------------|

   [[file:doc/keythemes.org][Full overview of bindings and configuration]]

** License

 Gnu General Public License v3.0, http://www.gnu.org/copyleft/gpl.html

** See also

*** http://orgmode.org/
    The official org-mode website

*** [[https://github.com/edwtjo/evil-org-mode][org-mode by edwtjo]]
    Original org-mode plugin by edwtjo from which this project was forked

*** https://github.com/GuiltyDolphin/org-evil
    Alternative integration of evil and org with different keybindings

*** [[http://orgmode.org/orgcard.pdf]]
    A handy cheat sheet, even if using this plugin